README.textile in jekyll-0.1.2 vs README.textile in jekyll-0.1.3
- old
+ new
@@ -25,21 +25,51 @@
My own personal site/blog is generated with Jekyll.
The proto-site repo ("http://github.com/mojombo/tpw":http://github.com/mojombo/tpw)
is converted into the actual site ("http://tom.preston-werner.com/":http://tom.preston-werner.com)
-h2. Install and Run
+h2. Install
-This is beta software. You will need to download the source
-and run the software from there.
+The best way to install Jekyll is via RubyGems:
- $ sudo gem install RedCloth
- $ sudo gem install liquid
- $ sudo gem install classifier
+ $ sudo gem install jekyll
+
+h2. Run
+
+ $ cd /path/to/proto/site
+ $ jekyll
+
+This will generate the site and place it in /path/to/proto/site/_site. There is an autobuild feature that will regenerate your site if any of the files change:
+
+ $ jekyll --auto
+
+If you'd like the generated site placed somewhere else:
+
+ $ jekyll /path/to/place/generated/site
+
+And if you don't want to be in the proto site root to run Jekyll:
+
+ $ jekyll /path/to/proto/site /path/to/place/generated/site
+The autobuid feature can be used on any of the invocations.
+
+h2. Contribute
+
+If you'd like to hack on Jekyll, grab the source from GitHub. To get
+all of the dependencies, install the gem first.
+
$ git clone git://github.com/mojombo/jekyll
- $ cd jekyll
- $ bin/jekyll /path/to/proto/site /path/to/place/generated/site
+
+The best way to get your changes merged back into core is as follows:
+
+# Fork mojombo/jekyll on GitHub
+# Clone down your fork
+# Create a topic branch to contain your change
+# Hack away
+# Do not change the version number, I will do that on my end
+# If necessary, rebase your commits into logical chunks, without errors
+# Push the branch up to GitHub
+# Send me (mojombo) a pull request for your branch
h2. License
(The MIT License)