summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/eolang/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/eolang/README.md')
-rw-r--r--macros/latex/contrib/eolang/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/macros/latex/contrib/eolang/README.md b/macros/latex/contrib/eolang/README.md
index 2214b74e38..1d71ee7817 100644
--- a/macros/latex/contrib/eolang/README.md
+++ b/macros/latex/contrib/eolang/README.md
@@ -1,3 +1,5 @@
+# LaTeX package for 𝜑-calculus
+
[![l3build](https://github.com/objectionary/eolang.sty/actions/workflows/l3build.yml/badge.svg)](https://github.com/objectionary/eolang.sty/actions/workflows/l3build.yml)
[![CTAN](https://img.shields.io/ctan/v/eolang)](https://ctan.org/pkg/eolang)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/objectionary/eolang.sty/blob/master/LICENSE.txt)
@@ -6,7 +8,7 @@ This LaTeX package helps you write 𝜑-calculus formulas and
draw [SODG](https://github.com/objectionary/sodg) graphs
for [EO](https://www.eolang.org) programming language.
-First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
+First, [install it][install]
from [CTAN](https://ctan.org/pkg/eolang)
and then use in the preamble:
@@ -22,10 +24,13 @@ x -> [
\end{document}
```
-Otherwise, you can download [`eolang.sty`](https://objectionary.github.io/eolang.sty/eolang.sty) and add to your project.
+Otherwise, you can download [`eolang.sty`][sty] and add to your project.
-If you want to contribute yourself, make a fork, then create a branch,
+If you want to contribute yourself, make a fork, then create a branch,
then run `l3build ctan` in the root directory.
It should compile everything without errors. If not, submit an issue and wait.
Otherwise, make your changes and then run `l3build ctan` again. If the build is
still clean, submit a pull request.
+
+[install]: https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages
+[sty]: https://objectionary.github.io/eolang.sty/eolang.sty