reboot the gnunet-guile project

1 files changed, 26 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c1110b7
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Guile bindings for GNUnet
+—————————————————————————
+
+Work in progress!
+
+To try the stub gnunet-search clone, you must have a working GNUnet
+configuration. Edit the file `examples/search.scm` and modify the line
+
+    (define config-file "~/.gnunet/gnunet.conf")
+
+to match your current GNUnet configuration file.
+
+Then, go inside the bindings directory and run `search.scm` as a
+script. For instance, to run a search on the keywords "foo" and "bar":
+
+    $ cd guix/gnunet/
+    $ examples/search.scm "foo" "bar"
+
+This will start a 5 seconds search on the given keywords. Here’s the
+output when exactly one find matches the keyword “foo”:
+
+  gnunet-download -o "foo.txt" gnunet://fs/chk/M976V69FDSQDH74AORDDLB…
+
+You can also check your bindings with the command:
+
+    $ ./run-tests.scm