Merge pull request #5 from hughlang/master

Added getting started and resources/links to README

README.rst

@@ -4,9 +4,64 @@ Homestead-guide
 
 Homestead guide is the reference documentation accompanying the homestead release of the ethereum project.
 
-
 `Hosted on ReadTheDocs`_
 
+GETTING STARTED
+======================
+
+This project uses Sphinx (http://www.sphinx-doc.org/en/stable/index.html) to build html that is published to Read the Docs. To run this documentation on your computer, you should do the following:
+
+Prerequisites
+---------------------
+* Python 2.6 or later
+* git
+
+Install Sphinx, etc
+---------------------
+For OSX/Linux users (based on instructions here: https://read-the-docs.readthedocs.org/en/latest/getting_started.html)
+
+* From command line: ``sudo pip install sphinx``
+
+For Windows users:
+
+* http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx
+
+Get source code
+---------------------
+* git clone: https://github.com/ethereum/homestead-guide.git
+
+Build and view html
+---------------------
+* In a terminal window, go to your homestead-guide directory.
+* ``make html``
+* ``cd build/html``
+* ``open index.html`` (open in web browser)
+* Tip: each time you run ``make html``, just reload your browser to view changes
+
+
+RESOURCES
+======================
+
+**Homestead**
+
+* Homestead Guide online: https://ethereum-homestead.readthedocs.org/en/latest/index.html
+* Github: https://github.com/ethereum/homestead-guide
+* Gitter: https://gitter.im/ethereum/homestead-guide
+* Google doc: https://docs.google.com/document/d/1rVjrNgaDRAQdPp4rGqWrEk5fPgiHff0xsYGCyf06oM8/edit
+
+**Legacy Docs**
+
+* Ethereum wiki: https://github.com/ethereum/wiki/wiki
+* Frontier Guide: https://ethereum.gitbooks.io/frontier-guide/content/
+* Frontier Guide on github: https://github.com/ethereum/frontier-guide
+
+**Read the Docs and Sphinx**
+
+- Read the Docs: https://read-the-docs.readthedocs.org/en/latest/getting_started.html
+- Sphinx docs: http://www.sphinx-doc.org/en/stable/contents.html
+- reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html
+- RST cheat sheet: https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
+
 
 Roadmap for homestead guide
 ==============================