Check for additional PEP8 problems.

[crypto-install.git] / README.md

diff --git a/README.md b/README.md
index eef6c8a..50a36c8 100644 (file)
--- 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.
 
 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:
 # 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.
 
 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.