diff options
| author | David Thompson <dthompson2@worcester.edu> | 2015-04-12 10:24:19 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2015-04-12 10:24:19 -0400 |
| commit | ba85e9e6c758432ca77e13e3c53643a8887c1a17 (patch) | |
| tree | e3a168e3a9139e7d30ccfcf23a8daaeb90f75fd5 | |
| parent | c529bbd0bdd77f51bba4693383f33562def6bb72 (diff) | |
Update README.
* README.md: Update intro. Add example configuration and usage.
| -rw-r--r-- | README.md | 44 |
1 files changed, 39 insertions, 5 deletions
@@ -4,17 +4,51 @@ Haunt About ----- -Haunt is a static site generator written in Guile Scheme. +Haunt is a static site generator written in Guile Scheme. It's +simple, functional, and extensible. Features -------- -* SXML templates +* Easy blog and Atom feed generation +* Supports any markup language that can be parsed to SXML * Simple development server -* Easy deployment -* Extensible +* Purely functional build process +* User extensible + +Example Configuration +--------------------- + +``` +(use-modules (haunt site) + (haunt reader) + (haunt builder blog) + (haunt builder atom) + (srfi srfi-19)) + +(site #:title "Built with Guile" + #:domain "dthompson.us" + #:default-metadata + '((author . "David Thompson") + (email . "davet@gnu.org") + ;; If I'm careless and forget a date, use the UNIX epoch. + (date . (make-date 0 0 0 0 1 1 1970))) + #:readers (list sxml-reader html-reader) + #:builders (list (blog) + (atom-feed) + (atom-feeds-by-tag))) +``` + +Usage +----- + +Write a configuration file named `haunt.scm`. Add your posts to a +directory named `posts`. Then run `haunt build`! + +To view your creation, run `haunt serve` and browse to +`localhost:8080`. License ------- -GNU GPLv3 +GNU GPLv3 or later |