README.org

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