README

   1 Why grml-gen-zshrefcard?
   2
   3   It's a tedious to document the same code in two different places.
   4   Therefore grml-gen-zshrefcard is our poor-man's-doxygen for our zshrc.
   5
   6 How does it work?
   7
   8   It (the Perl script genrefcard.pl) creates a new latex source file for
   9   our zsh-refcard from the zshrc itself and a tex input file
  10   (grml-zsh-refcard.tex.in).
  11
  12 How do I work with it?
  13
  14   (quickstart)
  15   % cd ~/src/grml
  16   % git clone git://git.grml.org/grml-gen-zshrefcard.git
  17   % git clone git://git.grml.org/grml-etc-core.git
  18   % cd grml-gen-zshrefcard
  19   % make test
  20
  21   The format of the inline documentation comments is described at the
  22   top of etc/zsh/zshrc in grml-etc-core. Additional information about
  23   the replacement tokens in grml-zsh-refcard.tex.in can be found at the
  24   top of the genrefcard.pl script.
  25
  26   Make your changes to grml-etc-core and check if you're happy with the
  27   result of 'make test'. Only changes to the meta-information at the top
  28   of the refcard should go into grml-gen-zshrefcard.