summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/stex/example/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/stex/example/README')
-rw-r--r--Master/texmf-dist/doc/latex/stex/example/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/stex/example/README b/Master/texmf-dist/doc/latex/stex/example/README
new file mode 100644
index 00000000000..7424d68ebca
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/stex/example/README
@@ -0,0 +1,18 @@
+This directory contains a typical (if minimal) example of a sTeX
+collection, and a Makefile-based conversion workflow. It is intended
+to test the sTeX distribution and serve as an example for sTeX users
+to set up their system. It contains
+
+README: this file
+Makefile: this contains rules to automate the PDF formatting and
+ XML conversion process.
+background: a directory with background modules, this is assumed to
+ exist before starting work on the paper, in real life this
+ would probably be a subversion external.
+paper: a directory with a paper based on two modules and the
+ background modules.
+test: a directory that has the makefiles to accomodate your tests;
+ just copy your files there adjust TARGET and type make.
+
+For an explanation of the design of the example see paper/example.pdf or
+https://trac.kwarc.info/sTeX/wiki/sTeXCollections