X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=README.md;h=0775d9f1dcc45a44d73523877adaace92a7891f9;hb=bc6e20b50145e3fe9e2888d34b5e94fe89a95ee1;hp=b44b2296ee18e90e6b105836d58e44b14430178a;hpb=566386c4970db990d3ef7dcd8fd610e78d114066;p=crypto-install.git

diff --git a/README.md b/README.md
index b44b229..0775d9f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,71 @@
-crypto-install.py
+crypto-install
 
 # USAGE
 
-Run the script to install a baseline setup.  Existing files are detected
-and not touched in the process, so running it is always safe to do.
+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 (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:
+
+    git clone https://github.com/Ferada/crypto-install.git
+    # or
+    git clone git@github.com:Ferada/crypto-install.git
+
+    cd crypto-install
+    make
+    cp build/crypto-install.py ~/bin # or wherever
+
+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.
+
+# LOCALISATION
+
+Currently working simultaneously on the English and German version.
+Patches welcome.
+
+To start off with a new translation, use:
+
+    cd po
+    msginit -l en_US # or whatever language code
+
+You'll have to confirm, or edit the email address and author.
+Afterwards, edit the new `.po` file as usual.
+
+Please read the `gettext` documentation (`info gettext`) for more
+details.