README.mkdn

   1 git-blog
   2 ========
   3
   4 git-blog intends to be blogging, simplified. You'll write your posts in your
   5 favorite text editor, with your favorite markup. Then save the post's file,
   6 `git-add` the post, and then `git-push origin master`. git-blog, running on
   7 your server, will catch the push and parse the post to your static HTML blog.
   8 Fast, no dynamic code being run on every load, free post versioning (git
   9 revisions), free sections (git branches), freedom of mind.
  10
  11 Philosophy & goals
  12 ------------------
  13
  14 git-blog will never be featureful, but it will also never be bloated. I doubt
  15 I will ever do anything more than parsing the posts to static HTML on every
  16 git-push.
  17
  18 Getting
  19 -------
  20
  21 The authoritative source for this project is available at
  22 <http://github.com/elliottcable/git-blog>. You can clone your own copy with the
  23 following command:
  24
  25     git clone git://github.com/elliottcable/git-blog.git
  26
  27 If you want to make changes to the codebase, you need to fork your own github
  28 repository for said changes. Send a pullrequest to [elliottcable][5]
  29 when you've got something ready for the master that you think should be
  30 integrated into the root source.
  31
  32 Bugs or feature requests can be submitted by forking a repository as
  33 previously described, and then using [ditz][6] to add an issue.
  34
  35   [5]: <http://github.com/elliottcable> (elliottcable on GitHub)
  36   [6]: <http://ditz.rubyforge.org/> (Ditz issue tracking)
  37
  38 Requirements
  39 ------------
  40
  41 To run git-blog, you need the following gems:
  42
  43 * gem install git
  44 * gem install haml (if you wish to create your templates in haml)
  45 * gem install jgarber-redcloth --source=http://gems.github.com (if you wish to write your posts in Markdown or Textile)
  46
  47 To develop and contribute to git-blog, you also need:
  48
  49 * gem install rspec
  50 * gem install rake
  51 * gem install rcov
  52 * gem install technomancy-ditz --source=http://gems.github.com