path: root/README.rst
diff options
authorPhilipp Gesang <>2014-03-02 12:30:04 +0100
committerPhilipp Gesang <>2018-12-02 21:09:41 +0100
commit6f347f84dfcf6f2ea862426c242160ecece453c6 (patch)
tree22210c8731b7d349e5f35961a551a0264d48706b /README.rst
parent5950a39c40b9d4be7157df74f153c260b7a8c684 (diff)
fix readme
Diffstat (limited to 'README.rst')
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 8b4f6d5..8eef452 100644
--- a/README.rst
+++ b/README.rst
@@ -26,11 +26,13 @@ The module package is built using omake_ which you can install via your
distribution’s package manager or through OPAM_.
opam install omake
Now retrieve the repository using Mercurial:
hg clone
You should end up with a directory ``context-rst`` containing the
@@ -42,6 +44,7 @@ Assuming you have downloaded the module as part of your distribution
package using these commands:
cd context-rst
omake tds
@@ -50,6 +53,7 @@ subdirectory that you can extract directly into your Context TEXMF.
If you are curious about the repository then issue
omake usage
to print a list of available targets.
@@ -67,6 +71,7 @@ For example, if your Context distribution is located in ``~/context``,
then unzip the archive into your local TEXMF like so:
cd ~/context/tex/texmf-local/
unzip /path/to/
context --generate
@@ -88,6 +93,7 @@ Assuming the contents of the TDS zipball were extracted to the current
directory you can build the documentation manually like so:
mkdir tmp; cd tmp
mtxrun --script rst --if=../doc/context/third/rst/documentation.rst --of=doc.tex
context ../doc/context/third/rst/manual.tex
@@ -95,6 +101,7 @@ directory you can build the documentation manually like so:
Alternatively, if you downloaded the Mercurial repository, simply issue
mkdir tmp; cd tmp
mtxrun --script rst --if=../doc/documentation.rst --of=doc.tex
context ../doc/manual.tex
@@ -103,6 +110,7 @@ If |rstcontext| is currently not installed in your Context tree, then
you can just link the required file to the ``tmp`` directory:
ln -s ../src/* .
Now the documentation should build regardless.