source: code/trunk/readme@ 9

Last change on this file since 9 was 3, checked in by fox, 3 years ago
  • Removed 'txt init'

Format

  • New B32 ID

Index

  • New option: txt index --print
  • Move scheme to peers
  • Replace peer.*.conf files with index packed locations Instead of adding a URL to peers.*.conf, run txt pull <url>

Conversion

  • Rewritten converters
  • txt-convert looks for a .convert.conf containing key: value lines.
  • Specifiable topic-roots from .convert.conf.
  • Added Topics: key, with comma seperated topics.

If set only those topics will appear in the main index and used as topic roots.
Other topics will have sub-indices generated, but won't be listed in the main index.

  • HTML converter header & footer options
  • HTML-index renamed to HTM-index

Internal

  • Change types: uuid:Uuid -> id:string
  • File_store merges identical texts
  • Use peer ID for store path, store peers' texts in .local/share/texts
  • Simple URN resolution for converter

Continue to next feed if parsing one fails

  • Phasing-out Archive, replaced by improved packs
  • Eliminate Bos, Cohttp, lwt, uri, tls, Re, Ptime, dependencies
  • Lock version for Cmdliner, fix dune-project
  • Optional resursive store
  • Improve header_pack
  • Fix recursive mkdir
File size: 833 bytes
Line 
1Logarion is a text header-format and suite of tools, for discovering, collecting & exchanging texts.
2
3Guide: <http://texts.orbitalfox.eu/11bcd8e9.htm>
4Source: <http://git.disroot.org/orbifx/logarion>
5IRC: <irc://tilde.chat/#logarion>
6EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>
7
8
9Header fields
10
11ID: unique identifier
12Date: of creation, ISO8601 formatted
13Topics: comma seperated list of topic names & phrases
14Title:
15Authors:list of name with optional set of <address>
16
17A blank line must seperarate the header from the body.
18
19
20Build development version
21
22Install `ocaml` and `opam`. Then build and install Logarion using opam's pin function:
23
24```
25opam pin add text_parse https://git.disroot.org/orbifx/text-parse-ml.git
26opam pin add logarion https://git.disroot.org/orbifx/logarion.git
27opam install logarion
28```
Note: See TracBrowser for help on using the repository browser.