From c6f9d0a4878b2e94e92cc8fce5800fb43185be4d Mon Sep 17 00:00:00 2001 From: Vivien Kraus Date: Thu, 29 Jul 2021 16:50:00 +0200 Subject: Update the README --- README | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) 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: -- cgit v1.2.3