README.org

   1
   2 #+title: Sigil Utilities
   3
   4 A simple utility that
   5
   6 * Usage
   7 `sigutils [options] <STATEMENT OF INTENT>`
   8
   9 -h     Print this message and quit.
  10 -v     Print the version and license info, then quit.
  11 -n     Append the numerical and root values to the result.
  12 -w     Generate a Word Square based on the SOI
  13
  14 * Installation
  15
  16 Make sure that you have a 'bin' directory in ~ that is visible from
  17 your system's PATH.
  18
  19 After that, run `make` and `make install`
  20
  21 * Contributing
  22
  23 Found a bug? Send me an email.
  24
  25 Want to make changes to the code? Clone the repository, create a new
  26 git branch and send me patch files for that branch using:
  27
  28 `git format-patch -<number of commits in your branch>`
  29
  30 ex. : `git format-patch -3`