New readme & header format

This commit is contained in:
orbifx 2022-07-30 14:19:29 +01:00
parent b30053d16e
commit 20d11b1bfe
3 changed files with 31 additions and 23 deletions

header Normal file
View File

@ -0,0 +1,19 @@
ID: Unique identifier
Date: ISO8601 date of creation
Topics: Comma seperated list of topic names & phrases
Title: A title for the text, ideally less than 70 characters
Authors: List of name with optional set of <address>
Date-edited: ISO8601, use only when text edited
A blank line must follow the last header field.
ID: 11bcd
Title: A Logarion exemplar header
Authors: John Doe <> <>
Date: 1970-11-06T12:29:50-00:00
Topic: Logarion, examples
Hello world!

install Normal file
View File

@ -0,0 +1,7 @@
Install development version
Requirements are ocaml (the compiler) and opam (the package manager). Then run:
opam pin add text_parse git://
opam pin add logarion git://
opam install logarion

View File

@ -1,28 +1,10 @@
Logarion is a text header-format and suite of tools, for discovering, collecting & exchanging texts.
discover, collect & exchange plain text files
Guide: <>
Header format: <>
Source: <>
IRC: <irc://>
EUPL licence: <>
Header fields
ID: unique identifier
Date: of creation, ISO8601 formatted
Topics: comma seperated list of topic names & phrases
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
opam pin add logarion
opam install logarion
IRC: <irc://>