summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/yathesis/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/yathesis/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/yathesis/README.md')
-rw-r--r--macros/latex/contrib/yathesis/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/macros/latex/contrib/yathesis/README.md b/macros/latex/contrib/yathesis/README.md
new file mode 100644
index 0000000000..fdbaeb4727
--- /dev/null
+++ b/macros/latex/contrib/yathesis/README.md
@@ -0,0 +1,40 @@
+-----------------------------------------------------------------------
+
+- `yathesis` --- Yet Another Thesis Class, version 0.99u
+- E-mail: `denis.bitouze@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 of the code.
+
+Typesetting the documentation of the class 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
+ `.../doc/latex/yathesis/french/exemples/specimen/a-plat` directory,
+ with `yathesis-demo` package load at first place. If `latexmk` is available,
+ it is easier to run:
+
+ latexmk -g -norc -r ./latexmkrc -jobname=these -pdflatex="pdflatex %O '\RequirePackage{etoolbox}\AtEndPreamble{\RequirePackage{yathesis-demo}}\input{%S}'" these.tex
+
+- to compile `yathesis-fr.tex` to be found in the
+ `.../doc/latex/yathesis/french/documentation` directory as follows:
+
+ latexmk -norc -r ./latexmkrc yathesis-fr