FEATURES and README update
[enki.git] / README
blobb966ece1127a803d6c47443e2dcfd9569eb5fe9c
1 = Enki
3 A ruby on rails blogging app for the fashionable developer.
5 THIS PROJECT IS NOT READY FOR PRIME TIME YET
7 Preferences are for the masses. Any real coder knows the easiest and best way to customize something is by hacking code. Because you want your blog to be you, not bog standard install #4958 with 20 posts per page instead of 15. For this you need a clean, simple, easy to understand code base that stays out of your way. No liquid drops and templates hindering your path, no ugly PHP stylings burning your eyeballs.
9 == Quick Start
11   git clone git://repo.or.cz/enki.git
12   cd enki
13   git checkout -b myblog # Create a new work branch
14   git cp config/database.example.yml config/database.yml
15   git cp config/defensio.example.yml config/defensio.yml # Will not be required in the future
16   # Edit config/enki.yml to taste
17   rake spec
19 == More info
21 Roboblog is a compact, easily extendable base for your blog. It does this by being highly opinionated, for example:
23 - Public facing views should adhere to standards (XHTML, Atom)
24 - /yyyy/mm/dd/post-title is a good URL for your posts
25 - Live comment preview by should be provided by default
26 - Google does search better than you or I
27 - You don't need a plugin system when you've got decent source control
28 - If you're not using OpenID you're a chump
30 == Author
32 Xavier Shay
33 xavier@rhnh.net
35 == License
37 GPL - See LICENSE
39 Includes code from http://simplelog.net/ (admin layout)