path: root/README.rst
diff options
authorPhilipp Gesang <>2010-09-23 23:36:22 +0200
committerPhilipp Gesang <>2010-09-23 23:36:22 +0200
commit158bf4cc70deff33c6b9016f73ea4c254f03f777 (patch)
tree4c0a0b91f5cd4148dd8fa67b16ecfa968d258282 /README.rst
parent998fb8a0fd13a6ede6ea1b76993927dcd20557df (diff)
fix readme
Diffstat (limited to 'README.rst')
1 files changed, 11 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 22d1fb9..ac7bf39 100644
--- a/README.rst
+++ b/README.rst
@@ -4,19 +4,25 @@ General Advice
Read the section *Features Not Implemented* in the manual first.
+*Note*: if you happen to read this on BitBucket, the error messages some lines
+below just mean that *their* implementation doesn’t understand TeX code. Don’t
-As converter was developed on *texlua*, you may expect it run best with this
+As rstConTeXt was developed on *texlua*, you may expect it to 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.
+through |CONTEXT| now. You will find extended instructions on how to build the
+manual with some cosmetic improvements in the section *Usage* of the manual
@@ -35,7 +41,10 @@ Contact
``com`` (find me on BitBucket_).
.. |rstcontext| ctx:: {\em rst}\kern.5pt\CONTEXT
.. _BitBucket:
.. _maintainer: Contact_