summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/stex/example/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-03-30 23:23:02 +0000
committerKarl Berry <karl@freefriends.org>2012-03-30 23:23:02 +0000
commit849996eca72af498b48b10fbea7f14c4b9d21b8f (patch)
tree2d40d42dfc9fc0b0622212cc220868f98345305f /Master/texmf-dist/doc/latex/stex/example/README
parentd82e1c23973fd0271f93686f487bd1cee8dcd947 (diff)
restore stex (ca. 28jan12)
git-svn-id: svn://tug.org/texlive/trunk@25792 c570f23f-e606-0410-a88d-b1316a301751
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