From 72c07b6b550738a18e6960a81ff5bb540c0c3acb Mon Sep 17 00:00:00 2001
From: Dan Frumin <dfrumin@cs.ru.nl>
Date: Sat, 29 Aug 2020 12:59:53 +0200
Subject: [PATCH] update README

---
 README | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/README b/README
index ec2d1b7..395fd2a 100644
--- a/README
+++ b/README
@@ -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.