aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorGustav Eek <gustav.eek@fripost.org>2022-05-26 08:40:58 +0200
committerGustav Eek <gustav.eek@fripost.org>2023-05-30 11:47:05 +0200
commit40332355f04f49c293999f2422c574465f18810b (patch)
tree61e4a163339f3442e43ddffd707f3c211c7813a4 /README
Inital commit.
Provide *README*, *.gitignore*, and *COPYING*
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 37 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..fa1be85
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+This repository contains styling for LaTeX and other applications that
+concerns [Fripost][1].
+
+[1]: https://fripost.org
+
+# Installation
+
+Run Make for compilation of DTX and INS LaTeX packaging:
+
+ make
+
+The LaTeX package is made locally available in *TEXMFHOME* through
+installation:
+
+ make install
+ make uninstall
+
+# Licence
+
+See *COPYING*
+
+# LaTeX Packaging
+
+LaTeX styles and classes, *.sty* and *.cls*, are traditionally shipped
+as bundles, *.dtx*. However, rather than writing the package files
+directly, there are alternatives that generate DTX from source style
+and documentation:
+
+ * [makedtx](https://www.ctan.org/pkg/makedtx) -- [makedtx v1.2: a Perl script to help create a DTX file
+ from source code](http://mirrors.ctan.org/support/makedtx/makedtx.pdf)
+
+ * [sty2dtx](https://www.ctan.org/pkg/sty2dtx)
+
+Fripost uses makedtx. Read the manual and see [*Makefile*](Makefile)
+for details of the compilation process.
+
+