home · contact · privacy
b7f03dd4ccb5cc319f40028e113dffa4a0ccb9ce
[redo-blog] / README.md
1 redo-blog
2 =========
3
4 small blog system using the redo build system
5
6 dependencies
7 ------------
8
9 - redo
10 - python3
11 - uuidgen
12 - html2text
13 - pandoc
14
15 testing
16 -------
17
18 Run ./test.sh.
19
20 setup
21 -----
22
23 To set up a directory with symbolic links to the relevant files in ./processor/,
24 run ./add_dir.sh DIRECTORY.
25
26 You can then enter the directory and run redo there. This will generate article
27 .html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml.
28 These files will be linked to symbolically in a directory ./public/. (Some
29 metadata files will also be generated below ./metadata/: for each article, there
30 will be generated a .uuid and a .intermediate file; furthermore, files for data
31 used in ./feed.xml and ./index.html will be built and can be edited to customize
32 the blog: ./metadata/url, ./metadata/author, ./metadata/uuid, ./metadata/title.) 
33
34 bugs
35 ----
36
37 Don't create a index.rst or index.md in the redo-managed directory, that will
38 break things.