summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/formal-grammar/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/formal-grammar/README.md')
-rw-r--r--macros/latex/contrib/formal-grammar/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/macros/latex/contrib/formal-grammar/README.md b/macros/latex/contrib/formal-grammar/README.md
new file mode 100644
index 0000000000..9a8e13b030
--- /dev/null
+++ b/macros/latex/contrib/formal-grammar/README.md
@@ -0,0 +1,25 @@
+# Package `formal-grammar`
+
+This package provides an easy way to write formal grammars.
+
+To use it, run the following commands:
+```
+$ latex formal-grammar.ins
+$ pdflatex formal-grammar.dtx
+```
+The first command generates the file `formal-grammar.sty` that should be placed
+in the same folder than your main document. The second command generates the
+file `formal-grammar.pdf` (you may require multiple runs to adjust internal
+references), which is the documentation for the package.
+
+# License
+
+This package is provided under the terms of the LaTeX Project Public License,
+version 1.3 or later.
+
+# See also
+
+ - [**simplebnf**](https://www.ctan.org/pkg/simplebnf): this package provides an
+ easier way to describe the grammar (no need to use special commands), but
+ offers less customisation options (highlight, etc.).
+ - [**backnaur**](https://www.ctan.org/pkg/backnaur).