summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83c2fae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Typesetting rules for the `just` build system
+
+A collection of rules related to typesetting.
+
+- Latex
+ - `["latex", "standalone"]` Simple rule to generate a `pdf` file,
+ given a collection of source files and the entry point.
+ - `["latex", "verbatim"]` Auxiliary target to wrap a file in a
+ `verbatim` environment. Useful if the source file is generated,
+ e.g., a sample run of a tool under development.
+ - `["ps", "family"]` Generate a collection of `eps` files from
+ a single `eps` file by replacing the definition of `stage` and
+ `drawbb`. While not strictly related to latex, usually used
+ for "animated" diagrams in slides.
+- Pandoc
+ - `["pandoc", "standalone"]` Generate a single output file from
+ a given list of files in order and a template.
+ - `["pandoc", "template"]` Specify a template for pandoc by
+ specifying additional arguments and files for a pandoc invocation.
+ - `["files", "ordered"]` Specify a list of files in order. In
+ this way, a sequence of files can be specified in a single
+ place, even so it is used in different pandoc targets, e.g.,
+ to render with different templates.