Changeset 14 in code for trunk/readme

Timestamp:

Jul 30, 2022, 1:29:20 PM (3 years ago)

Author:

fox

Message:

New readme & header format

File:

• trunk/readme (modified) (1 diff)

trunk/readme

@@ -1 @@
-Logarion is a text header-format and suite of tools, for discovering, collecting & exchanging texts.
+Logarion
+        discover, collect & exchange plain text files
 
 Guide: <http://texts.orbitalfox.eu/11bcd8e9.htm>
+Header format: <http://git.disroot.org/orbifx/logarion/raw/branch/master/header>
+
 Source: <http://git.disroot.org/orbifx/logarion>
-IRC: <irc://tilde.chat/#logarion>
 EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>
 
-
-Header fields
-
-ID:     unique identifier
-Date:   of creation, ISO8601 formatted
-Topics: comma seperated list of topic names & phrases
-Title:
-Authors:list of name with optional set of <address>
-
-A blank line must seperarate the header from the body.
-
-
-Build development version
-
-Install `ocaml` and `opam`. Then build and install Logarion using opam's pin function:
-
-```
-opam pin add text_parse https://git.disroot.org/orbifx/text-parse-ml.git
-opam pin add logarion https://git.disroot.org/orbifx/logarion.git
-opam install logarion
-```
+IRC: <irc://tilde.chat/#logarion>