summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVivien Kraus <vivien@planete-kraus.eu>2021-07-29 16:50:00 +0200
committerVivien Kraus <vivien@planete-kraus.eu>2021-07-29 18:43:54 +0200
commitc6f9d0a4878b2e94e92cc8fce5800fb43185be4d (patch)
tree630d8d0de5266dfba442d423e2cfade66c0d44d6
parent43a190f9bf30d1dbe47ebaf11abc5add05aa20ad (diff)
Update the README
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
index 2a4aad4..79a416a 100644
--- a/README
+++ b/README
@@ -6,6 +6,46 @@
This is a WIP implementation of the OIDC specification with
decentralization through webid.
+* Installation
+
+You can install it with GNU Guix, by using the following channel:
+
+[[https://labo.planete-kraus.eu/webid-oidc-channel.git]]
+
+It always tracks the latest commit.
+
+Otherwise, you need the following tools:
+
+- the autotools: automake, autoconf, autoconf-archive, libtool, gettext;
+- pkg-config;
+- texinfo;
+- help2man to generate the manual;
+- which and the coreutils;
+- guile;
+- guile-json;
+- guile-rdf: [[https://framagit.org/tyreunom/guile-rdf]]
+- guile-jsonld: [[https://framagit.org/tyreunom/guile-jsonld]]
+- nettle.
+
+These are the run-time dependencies:
+
+- guile
+- guile-json
+- guile-rdf
+- guile-jsonld
+- gnutls (so that guile can fetch resources with https)
+- nettle
+
+To build, first run the =bootstrap= script, then =./configure=,
+=make=. You can run the program without installing it, by running
+=./pre-inst-env guile src/webid-oidc=, or you can install it with
+=make install=.
+
+* Running
+
+Once installed, you get a program named =webid-oidc=. Run it with =-h=
+to get the options.
+
# Local Variables:
# mode: org
# End: