summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/modular/doc/README-doc.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/modular/doc/README-doc.md')
-rw-r--r--macros/latex/contrib/modular/doc/README-doc.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/macros/latex/contrib/modular/doc/README-doc.md b/macros/latex/contrib/modular/doc/README-doc.md
new file mode 100644
index 0000000000..33aa60fc1e
--- /dev/null
+++ b/macros/latex/contrib/modular/doc/README-doc.md
@@ -0,0 +1,8 @@
+The main documentation file is `modular.tex`.
+Build it to produce the package documentaiton.
+
+The documentation refers to an example project whose sources are in `example/`.
+Build `example/octopus/article.tex` to see a short article about octopuses.
+Build `example/article_failed.tex` for a failed attempt at re-using the octopus article's content in an article about sea animals.
+Build `example/article.tex` for a successful attempt using `modular`.
+