Browse Source

hurr doc durr

encrypt 8 years ago
parent
commit
1356716b1c
1 changed files with 23 additions and 1 deletions
  1. 23 1
      README.md

+ 23 - 1
README.md

@@ -1,4 +1,26 @@
 boh
 ===
 
-Transform markdown files into html.
+boh is a simple static website generator with minimal support for templates and YAML frontmatter.
+
+
+Requirements
+------------
+
+ * a markdown to html converter
+ * **envsubst** from GNU gettext package.
+
+Basic usage
+-----------
+
+```
+sudo make install
+boh new
+boh build
+touch index.md
+boh serve
+```
+Hacking
+-------
+
+boh is easly hackable with the boh.config file, for an example check [boh blog](https://github.com/encrypt94/boh-blog)