From d744e470236b55d5ea94aa1087e2c8b88fc05d2a Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Tue, 4 Jul 2023 15:25:00 +0200 Subject: [PATCH] Add README files --- pgpainless-wot-cli/README.md | 19 +++++++++++++++++++ pgpainless-wot/README.md | 12 ++++++++++++ wot-dijkstra/README.md | 9 +++++++++ 3 files changed, 40 insertions(+) create mode 100644 pgpainless-wot-cli/README.md create mode 100644 pgpainless-wot/README.md create mode 100644 wot-dijkstra/README.md diff --git a/pgpainless-wot-cli/README.md b/pgpainless-wot-cli/README.md new file mode 100644 index 00000000..e24ead9f --- /dev/null +++ b/pgpainless-wot-cli/README.md @@ -0,0 +1,19 @@ + + +# Command Line Interface for the Web-of-Trust + +This module contains a command line interface application that acts as a front-end for +[`pgpainless-wot`](../pgpainless-wot). + +## Build + +To build the application, navigate into this subdirectory and execute the following command: +```shell +../gradlew installDist +``` + +A ready-to-use distributable directory can then be found in `build/install/` with an executable in `build/install/pgpainless-wot-cli/bin/`. \ No newline at end of file diff --git a/pgpainless-wot/README.md b/pgpainless-wot/README.md new file mode 100644 index 00000000..31591b42 --- /dev/null +++ b/pgpainless-wot/README.md @@ -0,0 +1,12 @@ + + +# Web-of-Trust + PGPainless + +This module plugs PGPainless as an OpenPGP backend into [`wot-dijkstra`](../wot-dijkstra) to implement the +[Web of Trust](https://sequoia-pgp.gitlab.io/sequoia-wot/). + +For a command line interface, check out [`pgpainless-wot-cli`](../pgpainless-wot-cli). \ No newline at end of file diff --git a/wot-dijkstra/README.md b/wot-dijkstra/README.md new file mode 100644 index 00000000..15650de0 --- /dev/null +++ b/wot-dijkstra/README.md @@ -0,0 +1,9 @@ + + +# Backend-agnostic Web-of-Trust Implementation + +This module contains an implementation of the Web-of-Trust which is agnostic of the cryptographic backend. \ No newline at end of file