Skip to content
This repository has been archived by the owner on Nov 1, 2017. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
defunkt committed Apr 23, 2010
1 parent 34da491 commit ce8195f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
20 changes: 7 additions & 13 deletions README.markdown
@@ -1,30 +1,24 @@
Develop.GitHub.com
==================

This is the code and data behind
[develop.github.com](http://develop.github.com).
The page content lives in the pages/ directory and is compiled into the HTML
output in p/. Normally, generated files like these wouldn't be checked into
source control, but it's required for the
[GitHub Pages](http://pages.github.com/) hosting.
This is the code and data behind <http://develop.github.com>.

If you edit a page, please remember to run 'rake' to recompile the site
and create a single commit including both your source and generated
files. This makes it as easy as possible for others to work with your
changes.
All content can be found in the _posts/ direcotry.


Dependencies, Getting Started
-----------------------------

Compiling the site requires maruku, which can be installed with:
Install [Jekyll][jk] an rake (both require Ruby):

gem install maruku
gem install jekyll rake

Once you've done that, just run rake to compile the site:
Once you've done that, run `rake` to compile the site:

rake

This should start a web server at <http://localhost:3000> which is now
serving your site, updating whenever you make changes.

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion Rakefile
@@ -1,7 +1,7 @@
desc "Generate the html files for the site"
task :gensite do
if system("type jekyll > /dev/null 2>&1")
exec "jekyll"
exec "jekyll --auto"
else
abort "Please `gem install jekyll`"
end
Expand Down

0 comments on commit ce8195f

Please sign in to comment.