Bump version for release 0.1.0.

[crypto-install.git] / README.md

diff --git a/README.md b/README.md
index 0775d9f..ec895e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
-crypto-install
+crypto-install - Baseline setup for GnuPG and OpenSSH
+
+# LICENSE
+
+This program is released under GNU General Public License v3 or any
+later version.
 
 # USAGE
 
@@ -34,11 +39,10 @@ Until I set up a better routine:
     git clone git@github.com:Ferada/crypto-install.git
 
     cd crypto-install
-    make
-    cp build/crypto-install.py ~/bin # or wherever
+    python setup.py install
 
-Simply copy the built file into your path and possibly ensure execution
-permissions.
+Using `--prefix` with `install` the path may be changed to just locally
+install it for e.g. the current user.
 
 # DEVELOPMENT
 
@@ -59,6 +63,18 @@ initially.
 Currently working simultaneously on the English and German version.
 Patches welcome.
 
+To run with a different language set, use:
+
+    TEXTDOMAINDIR=locale LANGUAGE=de_DE ./crypto-install
+
+(I would really like to if that environment variable is okay to use
+here!)
+
+**TODO**: If the application is installed, you should only have to set
+the `LANGUAGE` environment variable instead, as the default locale
+directory will be set during the installation (to
+`prefix/share/locale` probably).
+
 To start off with a new translation, use:
 
     cd po
@@ -69,3 +85,8 @@ Afterwards, edit the new `.po` file as usual.
 
 Please read the `gettext` documentation (`info gettext`) for more
 details.
+
+# TODO
+
+- Tweak default parameters; it should also be possible to tweak them,
+  e.g. via a `--paranoid` setting.