From cd5bdeb7d4fa9098baca5a5754ab4e6db0146e65 Mon Sep 17 00:00:00 2001 From: Zach DeCook Date: Thu, 25 Feb 2021 21:52:55 -0500 Subject: docs: add readme which serves as gemtext index --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..22d02fd --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Theological Markup Language to Gemtext + +Parses ThML XML and returns gemtext. + +Due to ThML's structure these converted documents have very nice section headings. + +This probably contains some bugs. + +## Usage + +```sh examples of how to use this program +# Download and convert John Owen's "The Mortification of Sin" into a local gemtext file +curl https://ccel.org/ccel/owen/mort.xml | ./thml2gmi.py /dev/stdin > mort.gmi +# Get an outline to a good confession of faith +wget https://ccel.org/anonymous/bcf.xml +./thml2gmi.py bcf.xml | grep '^#' + +``` + +## Links + +=> LICENSE.gmi Licensed under AGPLv3 + +=> thml2gmi.py Read the source code + +=> https://git.sr.ht/~earboxer/thml2gmi Source code repository -- cgit 1.4.1