X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=README.md;h=50a36c8c3ebfc3f64a0e5f3d68879afed97f9cf0;hb=20796adb638331e6bb48562405c83dc95114fb93;hp=eef6c8aa1da708037f749b717b5857eb93ba0a58;hpb=f575613bc4c97a2df1c7a4e36c386195c85a8920;p=crypto-install.git

diff --git a/README.md b/README.md
index eef6c8a..50a36c8 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,18 @@ Run the script to install a baseline setup for both GnuPG and OpenSSH.
 Existing files are detected and not touched in the process, so running
 it is always safe to do.
 
+# OPTIONS
+
+- `--no-gui` disables the GUI, which means text mode will be enabled for
+  everything including the passphrase input
+- `--no-gpg` disables the GnuPG key generation and related setup
+  routines
+- `--no-ssh` does the same for the OpenSSH setup
+- `--gpg-home` sets the directory for the GnuPG files
+- `--ssh-home` does the same for OpenSSH files
+
+There is also `-h/--help` and `-v/--version` as expected.
+
 # INSTALLATION
 
 Until I set up a better routine:
@@ -21,3 +33,17 @@ Until I set up a better routine:
 
 Simply copy the built file into your path and possibly ensure execution
 permissions.
+
+# DEVELOPMENT
+
+There is a `Makefile` available to run common commands, e.g.:
+
+    make # checks PEP8, runs tests, builds final file
+    make run # run the built program
+    make clean # remove build folder
+
+If you have [`git-hooks`](https://github.com/icefox/git-hooks)
+installed, then the two hooks in `git_hooks` will run the tests and
+check for PEP8 compatibility before committing as well.  Run
+`git hooks --install` in the checked out folder to register the hooks
+initially.