Browse Source

explicitly note software requirements

George C. Privon 7 years ago
parent
commit
a4496012cd
1 changed files with 18 additions and 0 deletions
  1. 18 0
      README.md

+ 18 - 0
README.md

@@ -20,6 +20,24 @@ Templates are included for the following journals:
 Note that the aastex62 template has the most descriptive information while the others are relatively bare-bones.
 Additionally, the necessary style files are *not* included in this distribution; you must obtain those from the relevant journal.
 
+# Requirements
+
+## Software
+
+These templates require:
+
+- [pandoc](https://pandoc.org)
+- A (La)TeX typesetting engine (If you want to actually make a pdf instad of just stopping at TeX source.
+
+Technically optional (but I have never seen a paper without citations and in-text references) you will also want:
+
+- [pandoc-citeproc](https://github.com/jgm/pandoc-citeproc)
+- [pandoc-crossref](https://github.com/lierdakil/pandoc-crossref)
+
+## Ancillary Files
+
+In order to create a PDF from your Markdown source (or to trun the demos included here) you will need the appropriate style file for the journal.
+
 # Licensing
 
 ## Documentation