README.md

   1 crypto-install - Baseline setup for GnuPG and OpenSSH
   2
   3 # LICENSE
   4
   5 This program is released under GNU General Public License v3 or any
   6 later version.
   7
   8 # USAGE
   9
  10 Run the script to install a baseline setup for both GnuPG and OpenSSH.
  11
  12 Existing files are detected and not touched in the process, so running
  13 it is always safe to do.
  14
  15 # OPTIONS
  16
  17 - `--no-gui` disables the GUI, which means text mode will be enabled for
  18   everything including the passphrase input
  19 - `--no-gpg` disables the GnuPG key generation and related setup
  20   routines
  21 - `--no-ssh` does the same for the OpenSSH setup
  22 - `--gpg-home` sets the directory for the GnuPG files (defaults to the
  23   value of `GNUPGHOME` or `~/.gnupg`)
  24 - `--ssh-home` does the same for OpenSSH files (defaults to `~/.ssh`)
  25
  26 There is also `-h/--help` and `-v/--version` as expected.
  27
  28 # ENVIRONMENT
  29
  30 - `FULLNAME`, `EMAIL`, `USER` are used to pre-fill the corresponding
  31   fields
  32
  33 # INSTALLATION
  34
  35 Until I set up a better routine:
  36
  37     git clone https://github.com/Ferada/crypto-install.git
  38     # or
  39     git clone git@github.com:Ferada/crypto-install.git
  40
  41     cd crypto-install
  42     python setup.py install
  43
  44 Using `--prefix` with `install` the path may be changed to just locally
  45 install it for e.g. the current user.
  46
  47 # DEVELOPMENT
  48
  49 There is a `Makefile` available to run common commands, e.g.:
  50
  51     make # checks PEP8, runs tests, builds final file
  52     make run # run the built program
  53     make clean # remove build folder
  54
  55 If you have [`git-hooks`](https://github.com/icefox/git-hooks)
  56 installed, then the two hooks in `git_hooks` will run the tests and
  57 check for PEP8 compatibility before committing as well.  Run
  58 `git hooks --install` in the checked out folder to register the hooks
  59 initially.
  60
  61 # LOCALISATION
  62
  63 Currently working simultaneously on the English and German version.
  64 Patches welcome.
  65
  66 To run with a different language set, use:
  67
  68     TEXTDOMAINDIR=locale LANGUAGE=de_DE ./crypto-install
  69
  70 (I would really like to if that environment variable is okay to use
  71 here!)
  72
  73 **TODO**: If the application is installed, you should only have to set
  74 the `LANGUAGE` environment variable instead, as the default locale
  75 directory will be set during the installation (to
  76 `prefix/share/locale` probably).
  77
  78 To start off with a new translation, use:
  79
  80     cd po
  81     msginit -l en_US # or whatever language code
  82
  83 You'll have to confirm, or edit the email address and author.
  84 Afterwards, edit the new `.po` file as usual.
  85
  86 Please read the `gettext` documentation (`info gettext`) for more
  87 details.
  88
  89 # TODO
  90
  91 - Tweak default parameters; it should also be possible to tweak them,
  92   e.g. via a `--paranoid` setting.