home · contact · privacy
Add some more info to the README.
[redo-blog] / README.md
1 redo-blog
2 =========
3
4 small blog system using the redo build system
5
6 dependencies
7 ------------
8
9 - python3
10 - uuidgen
11 - html2text
12
13 testing
14 -------
15
16 Run ./test.sh.
17
18 setup
19 -----
20
21 To set up a directory with symbolic links to the relevant .do files and other
22 important files, run ./add_dir.sh DIRECTORY.
23
24 You can then enter the directory and run redo there. This will generate article
25 .html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml.
26 (Some other metadata files will also be generated: for each article, there will
27 also be generated a .uuid and a .intermediate file; furthermore, files with
28 metadata used in ./feed.xml and ./index.html will be built and can be edited to
29 customize the blog: ./url, ./author, ./uuid, ./title.)