New readme & header format
This commit is contained in:
parent
b30053d16e
commit
20d11b1bfe
3 changed files with 31 additions and 23 deletions
19
header
Normal file
19
header
Normal 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.
|
||||||
|
|
||||||
|
|
||||||
|
Example
|
||||||
|
|
||||||
|
ID: 11bcd
|
||||||
|
Title: A Logarion exemplar header
|
||||||
|
Authors: John Doe <http://example.com> <jd@example.com>
|
||||||
|
Date: 1970-11-06T12:29:50-00:00
|
||||||
|
Topic: Logarion, examples
|
||||||
|
|
||||||
|
Hello world!
|
7
install
Normal file
7
install
Normal 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://orbitalfox.eu/text-parse-ml
|
||||||
|
opam pin add logarion git://orbitalfox.eu/logarion
|
||||||
|
opam install logarion
|
28
readme
28
readme
|
@ -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>
|
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>
|
Source: <http://git.disroot.org/orbifx/logarion>
|
||||||
IRC: <irc://tilde.chat/#logarion>
|
|
||||||
EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>
|
EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>
|
||||||
|
|
||||||
|
IRC: <irc://tilde.chat/#logarion>
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue