Changeset 3 in code for trunk/readme

Timestamp:

Apr 15, 2022, 1:17:01 PM (3 years ago)

Author:

fox

Message:

• 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:

• trunk/readme (modified) (1 diff)

trunk/readme

@@ -1 @@
-Logarion is a free and open-source text archive system. A blog-wiki hybrid.
+Logarion is a text header-format and suite of tools, for discovering, collecting & exchanging texts.
 
-Download: <https://logarion.orbitalfox.eu/downloads/>
-EUPL licence: <https://joinup.ec.europa.eu/software/page/eupl>
+Guide: <http://texts.orbitalfox.eu/11bcd8e9.htm>
+Source: <http://git.disroot.org/orbifx/logarion>
+IRC: <irc://tilde.chat/#logarion>
+EUPL licence: <http://joinup.ec.europa.eu/software/page/eupl>
 
 
-Start
+Header fields
 
-Create a folder and run `logarion init` from within it to produce `.logarion/config` configuration file.
-Run `logarion --help` for more options.
+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.
 
 
-Community & support
+Build development version
 
-* Website: <https://logarion.orbitalfox.eu>
-* Report an issue: <mailto:logarion@lists.orbitalfox.eu?subject=Issue:>
-* Discussion: <https://lists.orbitalfox.eu/listinfo/logarion>
-  or join via <mailto:logarion-join@lists.orbitalfox.eu>
+Install `ocaml` and `opam`. Then build and install Logarion using opam's pin function:
 
-
-Install development version
-
-        opam pin add text_parse git://orbitalfox.eu/text-parse-ml
-        opam pin add logarion git://orbitalfox.eu/logarion
-        opam install logarion
+```
+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
+```