Skip to content
Browse files

better README

  • Loading branch information...
1 parent c2cc5c7 commit 97f86f481f0d461496aa77bfb23a971e25203eb3 @justinfrench committed
Showing with 4 additions and 53 deletions.
  1. +4 −53 README.textile
57 README.textile
@@ -1,56 +1,7 @@
-h1. Enki
+h1. Enki UI Fork
-A Ruby on Rails blogging app for the fashionable developer.
+This is a fork of the wonderful "Enki": Rails blogging platform by Xavier Shay, in which I'm having some fun experimenting with the admin UI. My favorite part of the experiment so far is the screen for writing posts, which is a massive departure from your average blogging UI:
-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(Hypertext Preprocessor) stylings burning your eyeballs.
-h2. Quick Start
-<pre><code> git clone git:// enki
- cd enki
- git checkout -b myblog # Create a new work branch
- cp config/database.example.yml config/database.yml
- # Edit config/enki.yml and config/database.yml to taste
- # Next step needs libxml2 and libxslt1 and their headers
- # On Debian-based systems: apt-get install libxml2-dev libxslt1-dev
- # On Mac OS X: no action required
- rake db:migrate
- rake spec
- ./script/server
- # Load http://localhost:3000/admin in your browser</code></pre>
-Or for bonus points, fork "enki at github": and clone that instead.
-h2. More info
-Enki is a compact, easily extendable base for your blog. It does this by being highly opinionated, for example:
-* Public facing views should adhere to standards (XHTML(eXtensible Hypertext Markup Language), Atom)
-* /yyyy/mm/dd/post-title is a good URL for your posts
-* Live comment preview should be provided by default
-* Google does search better than you or I
-* You don't need a plugin system when you've got decent source control
-* If you're not using OpenID you're a chump
-* Hacking code is the easiest way to customize something
-h2. How it differs from Mephisto
-Mephisto is feature packed and quite customizable. It can however be daunting trying to find your way around the code, which isn’t so good if you’re trying to hack in your own features. Enki strips out a lot of the features that you probably don’t need (multiple authors and liquid templates, for example), and focuses on keeping a tight code base that is easy to comprehend and extend.
-*If you’re converting from Mephisto,* be sure to have a look at "enki-translator":
-h2. How it differs from SimpleLog
-Enki embodies much of the philosophy of SimpleLog, but does so in a style that is much more consistent with Rails best practices, making it easier to understand and hack the code.
-h2. Contributors, these guys rock
-<pre><code>git log | grep Author | sort | uniq</code></pre>
-h2. License
-GPL(General Public License) - See LICENSE
-Admin design heavily inspired by "Habari":
+This is all totally an experiment and a work in progress, originally thrown together for my presentation at "Melbourne Ruby in July 2009":

0 comments on commit 97f86f4

Please sign in to comment.
Something went wrong with that request. Please try again.