Permalink
Browse files

adds some initial documentation

  • Loading branch information...
jackmcdade committed Mar 30, 2012
1 parent e3c63c3 commit a27df9666c107889d2c424c22f6cfe0a98220c2d
Showing with 18 additions and 1 deletion.
  1. +18 −1 README.md
View
@@ -1,3 +1,20 @@
# Chronicle
It ain't ready yet. But it won't be long.
By Jack McDade (inspired by Travis Schmeisser)
Chronicle is a simple, chronilogically organized, file-based publishing engine. It takes a content directory (which can contain literally anything you want, as long as you have an index.php file), adds a little yaml magic for meta data, and powers all the navigation between entries.
## Getting Started
* Drop Chronicle on your server (local or otherwise)
* Customize the main `config.yaml` file to set your global site information
* Start publishing!
## Diving In
* Chronicle looks for date-based directories inside the `/content` directory and will automatically redirect the user to the newest "entry" upon visiting the root url ("/").
* Your entries have `$prev` and `$next` path variables available to use in your index.php file. For example, add previous and next entry navigation. Look in the `/content` directory for examples
* If you add a `meta.yaml` file to any given content subdirectory, any of the [YAML](http://en.wikipedia.org/wiki/YAML) key:value pairs will be availble to use in both the index.php view and archive listing page.
* Your archive page will pull all the meta data from all of your content directories to help you build a list. Look at `content/archive/index.php` for some examples.
### More complete documentation coming soon!

0 comments on commit a27df96

Please sign in to comment.