summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/causets/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/causets/README.md')
-rw-r--r--graphics/pgf/contrib/causets/README.md25
1 files changed, 11 insertions, 14 deletions
diff --git a/graphics/pgf/contrib/causets/README.md b/graphics/pgf/contrib/causets/README.md
index 56a3c857cd..76e8b4593f 100644
--- a/graphics/pgf/contrib/causets/README.md
+++ b/graphics/pgf/contrib/causets/README.md
@@ -1,7 +1,7 @@
-LaTeX Package: causets
-======================
-This is a LaTeX package to create (Hasse) diagrams of causal sets - short causets (locally finite, partially ordered sets) to be used inline with text or mathematical expressions, as well as with TikZ pictures.
+# The `causets` package
+The LaTeX package `causets` lets you create (Hasse) diagrams of causal sets. Causal sets (causets) are locally finite, partially ordered sets and are consider as a framework for quantum gravity. This package is built on the package `tikz`, which is usually included in the standard LaTeX installations and loaded automatically with `\usepackage{causets}`.
+The diagrams can be used inline with text or mathematical expressions, or they may be included in a TikZ pictures.
The three main commands (macros) are
```tex
% causet generated from a permutation:
@@ -13,13 +13,11 @@ The three main commands (macros) are
```
For a full documentation, please see causets.pdf.
+The documentation includes some examples.
+More examples are included at
+https://github.com/c-minz/LaTeX-causets/tree/main/examples
-Additional Packages
-===================
-This package is built on the package `tikz`, which is usually included in the standard LaTeX installations.
-
-Bug Reports
-===========
+## Bug reports
Problems with the package are reported here:
https://github.com/c-minz/LaTeX-causets/issues
@@ -34,12 +32,11 @@ Bug reports can be send to the maintainer:
C. Minz
christoph{dot}minz[AT]gmail{dot}com
-Information on Distribution
-===========================
+## License and distribution
Copyright 2020-2022 by C. Minz
-This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this license or (at your option) any later version.
-The latest version of this license is in
+This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this licence or (at your option) any later version.
+The latest version of this licence is in
http://www.latex-project.org/lppl.txt
This work has the LPPL maintenance status "maintained".
@@ -47,7 +44,7 @@ This work has the LPPL maintenance status "maintained".
The current maintainer of this work is C. Minz.
https://github.com/c-minz
-Current version: 1.2
+**Current version: v1.3**
CTAN location: /graphics/pgf/contrib/causets/