summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/chemsec/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/chemsec/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/chemsec/README.md')
-rw-r--r--macros/latex/contrib/chemsec/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/macros/latex/contrib/chemsec/README.md b/macros/latex/contrib/chemsec/README.md
new file mode 100644
index 0000000000..09d3d6f888
--- /dev/null
+++ b/macros/latex/contrib/chemsec/README.md
@@ -0,0 +1,48 @@
+# chemsec
+
+LaTeX style for automated creation of numeric chemical
+labels for scientific documents.
+
+For documentation run
+
+ latex chemsec.dtx
+
+To generate style file run
+
+ latex chemsec.ins
+
+The style file in this directory should always be identical
+to the file generated by `latex chemsec.ins`
+
+# Examples
+
+Several examples accompany the CTAN package in the `chemsec`
+directory. You can compile these by processing the files twice
+using a latex program.
+
+ <latex command> example1
+ <latex command> example1
+
+If you obtain the package from the GitHub repository you can run
+the examples by changing to the `test` subdirectory and using the
+supplied makefile. For example to process the `example1.tex` file
+use:
+
+ make clean example1
+
+or
+ make LATEX=latex clean example1
+
+if you want to use a latex program other than `pdflatex`.
+
+## Note
+
+* The examples use the chemsec.sty file in the base
+directory, this is not updated by the make program.
+
+* The make program copies the example latex files and the
+style file into the test directory. Dependency tracking
+should keep these up to date.
+
+* The clean target should remove everything but the
+makefile from the test directory.