add README
authorLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 7 Dec 2020 15:49:48 +0000 (15:49 +0000)
committerLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 7 Dec 2020 15:49:48 +0000 (15:49 +0000)
README.txt [new file with mode: 0644]

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..46ae525
--- /dev/null
@@ -0,0 +1,14 @@
+https://git.libre-soc.org/?p=utils.git;a=summary
+
+clone with:
+   git clone 'git://git.libre-soc.org/utils.git'
+
+install with "python3 setup.py develop" as root (or "python3 setup.py
+develop --user" and remember to add ~/.local/bin to $PATH)
+
+run as:
+    nohup budget-sync -c budget-sync-config.toml -o mdwn
+
+then examine the nohup.out and also the individual markdown files,
+or compile to html first:
+    markdown_py -f lkcl.html lkcl.mdwn