summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/yathesis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/yathesis/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/yathesis/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/yathesis/README.md b/Master/texmf-dist/doc/latex/yathesis/README.md
new file mode 100644
index 00000000000..651b194d120
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/yathesis/README.md
@@ -0,0 +1,42 @@
+-----------------------------------------------------------------------
+
+- `yathesis` --- Yet Another Thesis Class, version 0.99m
+- E-mail: `denis.bitouze@lmpa.univ-littoral.fr`
+- Released under the LaTeX Project Public License v1.3c or later. See
+ http://www.latex-project.org/lppl.txt
+
+-----------------------------------------------------------------------
+
+**The `yathesis` bundle provides a LaTeX class file to help to write a thesis
+following French rules.**
+
+The class is supplied in `.dtx` format. If you want to unpack the `.dtx`
+yourself, running:
+
+ pdftex yathesis.dtx
+
+will extract the class whereas:
+
+ pdflatex yathesis.dtx
+
+will extract it and also typeset the documentation.
+
+Typesetting the documentation requires:
+
+- a number of packages in addition to those needed to use the `yathesis`
+ classes. To compile the documentation without error, you will need, among
+ others, my personal (dirty) package `denisbdoc` for documenting the classes
+ I've written.
+- a complete `pdflatex` run of `these.tex` to be found in the
+ `.../yathesis/doc/latex/yathesis/exemples/specimen/a-plat` directory, with
+ `yathesis-demo` package load at first place. If `latexmk` is available, it is
+ easier to run:
+
+ latexmk -f -pdf -jobname=these -pdflatex= \
+ "pdflatex %O '\RequirePackage{yathesis-demo}\input{%S}'" these.tex
+
+- to run `pdflatex` on `yathesis.tex` to be found in the
+ `.../yathesis/doc/latex/yathesis/documentation` directory. If `latexmk` is
+ available, it is easier to run:
+
+ latexmk yathesis.dtx