Permalink
Browse files

Merged READMEs into on .rst file

  • Loading branch information...
codeinthehole committed Jan 30, 2012
1 parent b1a4313 commit 8e4e469c30929cb71dec368d8459f4d8f8ce4bd6
Showing with 49 additions and 27 deletions.
  1. +0 −27 README.md
  2. +49 −0 README.rst
View
@@ -1,27 +0,0 @@
-# Django Oscar Information Page #
-
-This repository contains the source for the [Django Oscar information page](http://tangentlabs.github.com/django-oscar/).
-
-## Dependencies ##
-
-[Jekyll](https://github.com/mojombo/jekyll/) is required. Follow the install instructions at the Jekyll [wiki](https://github.com/mojombo/jekyll/wiki/Install). You can install this via RubyGems:
-
- sudo gem install jekyll
-
-OSX users might need to update RubyGems:
-
- sudo gem update --system
-
-## Building and Viewing ##
-
-GitHub automatically builds Jekyll-based sites. If you want to make changes and edit locally, you'll need to install Jekyll (see above).
-
-### Running a local server ###
-
-cd into the `django-oscar` directory, and build by:
-
- jekyll --server --base-url=""
-
-…where `--base-url` is an option to override the baseurl setting in `_config.yml`. This setting is used in the templates as the placeholder `{{ site.baseurl }}`
-
-The generated site is available at `http://localhost:4000/`
View
@@ -0,0 +1,49 @@
+=============================
+Github pages for django-oscar
+=============================
+
+This repository contains the source for the `django-oscar information
+page`_.
+
+.. _`django-oscar information page`: http://tangentlabs.github.com/django-oscar/
+
+Installation
+------------
+
+`Jekyll`_ is required. Follow the install instructions at the `Jekyll wiki`_.
+You can install this via RubyGems::
+
+ sudo gem install jekyll
+
+.. _`Jekyll`: https://github.com/mojombo/jekyll/
+.. _`Jekyll wiki`: https://github.com/mojombo/jekyll/wiki/Install
+
+OSX users might need to update RubyGems::
+
+ sudo gem update --system
+
+Building and viewing
+--------------------
+
+GitHub automatically builds Jekyll-based sites. If you want to make changes and
+edit locally, you'll need to install Jekyll (see above).
+
+Running a local server
+----------------------
+
+Change directory into the `django-oscar` directory, and build by::
+
+ jekyll --server --base-url=""
+
+where ``--base-url`` is an option to override the baseurl setting in
+``_config.yml``. This setting is used in the templates as the placeholder ``{{
+site.baseurl }}``
+
+The generated site is available at http://localhost:4000/
+
+Follow the instructions for setting up Jekyll. You can view the site locally
+by running the Jekyll server::
+
+ jekyll --server
+
+and visiting http://localhost:4000/django-oscar/index.html

0 comments on commit 8e4e469

Please sign in to comment.