From 9c93389e4eb0f274f3afb241d586d5092771dc50 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 28 Aug 2011 13:24:19 +0200 Subject: updated readme --- README.rst | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 7bb1190..6682a85 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,17 @@ Read the section *Features Not Implemented* in the manual first. below just mean that *their* implementation doesn’t understand TeX directives. Don’t worry, |rstcontext| does. +============ +Installation +============ + +In order to install |rstcontext|, copy everything under the ``mod/`` +subdirectory into your local |CONTEXT| tree, i.e.: :: + + cp -r mod/* ~/context/tex/texmf-local/ + +if the |CONTEXT| minimal distribution happens to be installed at +``~/context/``. ===== Usage @@ -19,8 +30,7 @@ file and the output file. The following will demonstrate the main usage in a separate directory: :: mkdir tmp; cd tmp - ln -s ../mod/tex/context/third/rst/*.lua . - texlua rst_parser.lua ../mod/doc/context/third/rst/documentation.rst doc.tex + mtxrun --script rst --if=../mod/doc/context/third/rst/documentation.rst --of=doc.tex context ../mod/doc/context/third/rst/manual.tex This should have gotten you the manual converted to a file ``doc.tex`` which was @@ -29,15 +39,8 @@ will find extended instructions on how to build the manual with some cosmetic improvements in the section *Usage* of the manual itself. There is also a small module ``t-rst.mkiv`` which permits direct typesetting of -reST markup with |CONTEXT| MkIV. To install the module, simply copy anything -under the ``mod`` directory to your local |CONTEXT| tree. For instance, if -|CONTEXT| happens to be installed at ``~/context``, the installation would be -achieved this way: :: - - cp -r mod/* ~/context/tex/texmf-local/ - -For usage examples see the files ``hybridtest.tex`` and ``moduletest.tex`` in -the ``doc`` subdirectory. +reST markup with |CONTEXT| MkIV. For usage examples see the files +``hybridtest.tex`` and ``moduletest.tex`` in the ``doc`` subdirectory. ======= License -- cgit v1.2.3