Go to file
orbifx 95295aa6ed Revise readme 2022-02-06 17:23:33 +00:00
cli Improve documentation 2022-02-06 17:08:40 +00:00
lib Tidy convert and rename default dir in File_store, dev repo dune-project 2022-01-30 09:32:03 +00:00
.gitignore initial simple example with omd 2016-08-30 22:04:12 +01:00
Makefile Revise and tidy-up 2022-02-04 10:49:06 +00:00
dune-project Revise and tidy-up 2022-02-04 10:49:06 +00:00
logarion.opam Revise and tidy-up 2022-02-04 10:49:06 +00:00
readme Revise readme 2022-02-06 17:23:33 +00:00

readme

Logarion is a text header-format and suite of tools, for discovering, collecting & exchanging texts.

Website: <http://logarion.orbitalfox.eu>
Source: <http://git.disroot.org/orbifx/logarion>
Binaries built by Novaburst: <https://novaburst.bsd.tilde.team/logarion>
Questions & comments: <mailto:fox at orbitalfox.eu>
EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>


Start

Create a folder and run `logarion init` from within it to produce `.logarion/config` configuration file.
Run `logarion --help` for more options.
Guide to text repositories with Logarion  <http://texts.orbitalfox.eu/11bcd8e9.htm>


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` for your distribution. 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
```