summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/texsurgery/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/texsurgery/README.md')
-rw-r--r--macros/latex/contrib/texsurgery/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/macros/latex/contrib/texsurgery/README.md b/macros/latex/contrib/texsurgery/README.md
new file mode 100644
index 0000000000..0e5b0ff106
--- /dev/null
+++ b/macros/latex/contrib/texsurgery/README.md
@@ -0,0 +1,27 @@
+# TexSurgery
+
+This tex package is a companion to the `texsurgery` `python` project:
+
+[https://framagit.org/pang/texsurgery](https://framagit.org/pang/texsurgery)
+
+This `LaTeX` library will make sure that
+
+`pdflatex document.tex`
+
+will work, with reasonable defaults, for a document that is intended to work with `texsurgery`, and also has other uses, always in tandem with the `texsurgery` `pypi` package.
+
+However, remember that `texsurgery` is a `python` project whose main focus is on __evaluating code inside a `jupyter` kernel__, and this is _only_ achieved by installing the `python` package and calling the `texsurgery` command
+
+`texsurgery -pdf document.tex`
+
+## License
+
+The `texsurgery` `CTAN` package follows a [BSD license])(https://opensource.org/licenses/BSD-3-Clause), the same license as the `texsurgery` `python` project:
+
+[https://framagit.org/pang/texsurgery/-/blob/master/LICENSE](https://framagit.org/pang/texsurgery/-/blob/master/LICENSE)
+
+## texsurgery.pdf
+
+The file `texsurgery.pdf` in the texsurgery CTAN LaTeX package was generated with the command
+
+`pandoc README.md -o texsurgery.pdf`