From be403310650fdb0d9d84b9561dfb469bc3d3f43f Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@sunet.se>
Date: Fri, 3 Jan 2020 06:18:22 +0100
Subject: clean up the README's some

---
 p11p-daemon/README.md | 49 +++++++++++++++++++++----------------------------
 1 file changed, 21 insertions(+), 28 deletions(-)

(limited to 'p11p-daemon/README.md')

diff --git a/p11p-daemon/README.md b/p11p-daemon/README.md
index 8c7e7b9..84c339f 100644
--- a/p11p-daemon/README.md
+++ b/p11p-daemon/README.md
@@ -1,6 +1,6 @@
 # p11p-daemon is a PKCS #11 proxy
 
-## Install dependencies
+## Installing dependencies
 
 ### p11-kit
 
@@ -19,7 +19,7 @@ Or, if your p11-kit package is too old (<0.23.15):
 
 ### Erlang/OTP 19
 
-Ideally, your OS distribution has Erlang/OTP 19.x:
+Ideally, your OS distribution has Erlang/OTP 19 or newer:
 
     $ sudo apt install erlang
 
@@ -35,7 +35,7 @@ would be:
     $ ./kerl install 19.2 ~/kerl/19.2
     $ . ~/kerl/19.2/activate
 
-## Compile p11p-daemon
+## Compiling p11p-daemon
 
 If you don't have rebar3 installed, install it. See
 https://www.rebar3.org/docs/ .
@@ -51,36 +51,21 @@ Compile:
     $ cd p11p-daemon
     $ make
 
-## Configure p11p-daemon
+## Configuring p11p-daemon
 
 For now, see config/sys.config for how to configure virtual tokens,
-each with one or more PKCS #11 modules, i.e. shared libraries.
+each with one or more PKCS #11 module, i.e. shared library.
 
-## Run tests
+## Running p11p-daemon
 
-    $ sudo apt install softhsm2 gnutls-bin libengine-pkcs11-openssl
-    $ make -C tests
-
-# Manual testing
-
-    $ make -C p11p-daemon start
-
-
-To start an Erlang shell running the p11p application:
-
-    $ make shell
-
-Quit by typing in "q()." in the shell.
-
-To start a "release", running in the background and logging to files
-under _build/default/rel/p11p/log:
+To start p11p-daemon, running in the background and logging to files
+under _build/default/rel/p11p/log/:
 
     $ make start
 
-A socket per configured token, /run/user/$EUID/p11p/$TOKEN-$PID, can
-now be used by a client.
-
-Example using p11tool:
+A socket per configured token, /run/user/$EUID/p11p/$TOKEN-$PID, is
+made available and can now be used by a client. Example usage using
+p11tool:
 
     $ P11_KIT_SERVER_ADDRESS=unix:path=/run/user/1000/p11p/vtoken0-26585 P11_KIT_DEBUG=none p11tool --provider /usr/lib/pkcs11/p11-kit-client.so --list-tokens
     Token 0:
@@ -92,10 +77,18 @@ Example using p11tool:
         Serial: b4a861d362dbd386
         Module: (null)
 
-To stop the Erlang shell:
+To stop p11p-daemon:
 
     $ make stop
 
+## Debugging p11p-daemon
+
+To start an Erlang shell running the p11p application:
+
+    $ make shell
+
+Quit by entering "q()." in the Erlang shell.
+
 ## Known bugs and limitations
 
 - Multiple p11 applications using the same vtoken in a given
@@ -104,6 +97,6 @@ To stop the Erlang shell:
   TODO: Make this work, or prohibit it by rejecting a second user of
   the same vtoken.
 
-## Bug reports, questions, comments
+## Contact
 
   linus+p11p@sunet.se
-- 
cgit v1.1