summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst96
1 files changed, 55 insertions, 41 deletions
diff --git a/README.rst b/README.rst
index 8c0e6fd..571b8ae 100644
--- a/README.rst
+++ b/README.rst
@@ -1,20 +1,32 @@
-==============
-General Advice
-==============
+=======================================================================
+ 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| directives.
-Don’t worry, |rstcontext| does.
-
-============
-Installation
-============
-
-In order to install |rstcontext|, copy everything under the ``mod/``
-subdirectory into your local |CONTEXT| tree and update the filename database,
-i.e.: ::
+*Note*: if you happen to read this on BitBucket_, the error messages
+some lines below just mean that *their* implementation doesn’t
+understand |TeX| directives. Don’t worry, |rstcontext| does.
+
+=======================================================================
+ Installation
+=======================================================================
+With ConTeXt Standalone
+***********************
+An up to date version of the module is installed along with the ConTeXt
+distribution (*Standalone*, formerly known as *The Minimals*).
+The module should be working out of the box if you installed from the
+official source_ and provided the parameter ``--modules=all``.
+
+.. _source: http://wiki.contextgarden.net/ConTeXt_Standalone#Installing_third_party_modules
+
+Manually
+********
+Firstly, get the module source from BitBucket_ (see the *downloads*
+section).
+In order to install |rstcontext|, copy everything in the ``mod/``
+subdirectory into your local |CONTEXT| tree and update the filename
+database, i.e. ::
cp -r mod/* ~/context/tex/texmf-local/
context --generate
@@ -22,48 +34,50 @@ i.e.: ::
if the |CONTEXT| minimal distribution happens to be installed at
``~/context/``.
-=====
-Usage
-=====
+=======================================================================
+ Usage
+=======================================================================
-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. The following will demonstrate the main usage in a
-separate directory: ::
+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. The following will
+demonstrate the main usage in a separate directory: ::
mkdir tmp; cd tmp
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
-subsequently run through |CONTEXT| to generate the final ``manual.pdf``. You
-will find extended instructions on how to build the manual with some cosmetic
-improvements in the section *Usage* of the manual itself.
+This should have gotten you the manual converted to a file ``doc.tex``
+which was subsequently run through |CONTEXT| to generate the final
+``manual.pdf``. You 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. For usage examples see the files
-``hybridtest.tex`` and ``moduletest.tex`` in the ``doc`` subdirectory.
+There is also a small module ``t-rst.mkiv`` which permits direct
+typesetting of reST markup with |CONTEXT| MkIV. For usage examples see
+the files ``hybridtest.tex`` and ``moduletest.tex`` in the ``doc``
+subdirectory.
-=======
-License
-=======
+=======================================================================
+ 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_).
+|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
-=======
+=======================================================================
+ Contact
+=======================================================================
-|rstcontext| was written by Philipp Gesang, ``phg42.2a`` at ``gmail`` dot
-``com`` (find me on BitBucket_).
+|rstcontext| was written by Philipp Gesang, ``phg42.2a`` at ``gmail``
+dot ``com``.
.. |rstcontext| ctx:: {{\em rst}\kern.5pt\CONTEXT}
.. |TeX| ctx:: {\TEX}
.. |CONTEXT| ctx:: {\CONTEXT}
.. _Contact: phg42.2a@gmail.com
-.. _BitBucket: http://bitbucket.org/phg
+.. _BitBucket: http://bitbucket.org/phg/context-rst
.. _maintainer: Contact_