Add a bit of documentation, environment variables.

[crypto-install.git] / README.md

diff --git a/README.md b/README.md
index cad778f..278752f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,11 +14,17 @@ it is always safe to do.
 - `--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
+- `--gpg-home` sets the directory for the GnuPG files (defaults to the
+  value of `GNUPGHOME` or `~/.gnupg`)
+- `--ssh-home` does the same for OpenSSH files (defaults to `~/.ssh`)
 
 There is also `-h/--help` and `-v/--version` as expected.
 
+# ENVIRONMENT
+
+- `FULLNAME`, `EMAIL`, `USER` are used to pre-fill the corresponding
+  fields
+
 # INSTALLATION
 
 Until I set up a better routine:
@@ -33,3 +39,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.