New readme & header format

git-svn-id: file:///srv/svn/repo/kosuzu/trunk@14 eb64cd80-c68d-6f47-b6a3-0ada418499da
This commit is contained in:
fox
2022-07-30 13:29:20 +00:00
parent 4da228ae1b
commit 4f42df7037
3 changed files with 31 additions and 23 deletions

28
readme
View File

@@ -1,28 +1,10 @@
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>