update README

This commit is contained in:
Dan Frumin 2020-08-29 12:59:53 +02:00
parent d324baf487
commit 72c07b6b55
1 changed files with 18 additions and 3 deletions

21
README
View File

@ -1,5 +1,20 @@
UwU
Dan's idiotic static site compiler.
Requirements:
- calendar
- ISO8601
- ocaml libraries: omd (dev version) and ISO8601
- dune for building
- make (tested with GNU make)
Directory structure:
- static/
files from this directry will be copied to `/static'
- content/
all the .md files in the directory will be compiled to HTML
a file `content/X.md' will end up as `/posts/X.html'
the index of all the posts will end up as `/posts.html'
- ~/www/
whatever you have in ~/www/ will be copied over to the root directory
(i use org-mode to write static pages.. i know, it's a mess)
The src/webcc.ml program compiles markdown files to HTML.
It can also generate an index of all the posts.