README.md

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