diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..22d1fb9 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +============== +General Advice +============== + +Read the section *Features Not Implemented* in the manual first. + + +===== +Usage +===== + +As converter was developed on *texlua*, you may expect it run best with this +interpreter. For now the script accepts two command line arguments: the input +file and the output file: :: + + $texlua rst_parser.lua doc/documentation.rst man.tex + +This should get you the manual converted to a file ``man.tex`` which you can +through |CONTEXT| now. + +======= +License +======= + +|rstcontext| is free software and may be redistributed under the terms of the +2-clause BSD license. You should have recieved a copy of this license in a file +named “COPYING” in the source tree. If there is no such file then please contact +the maintainer_ (Contact_). + +======= +Contact +======= + +|rstcontext| was written by Philipp Gesang, ``megas.kapaneus`` at ``gmail`` dot +``com`` (find me on BitBucket_). + +.. |rstcontext| ctx:: {\em rst}\kern.5pt\CONTEXT +.. |CONTEXT| ctx:: \CONTEXT +.. _BitBucket: http://bitbucket.org/phg +.. _maintainer: Contact_ + |