No description or website provided.
Python Makefile Batchfile
Latest commit 604dfa8 Jan 19, 2017 @Souptacular Souptacular committed on GitHub Update contributors.rst




The Ethereum Homestead Guide is the reference documentation accompanying the Homestead release of the Ethereum project.

Hosted on ReadTheDocs


Homestead Documentation Initiative

It doesn't matter if you are a beginner or an expert, there are many ways to help.

Write Content to the Guide

Help transfer and update content from the Ethereum Wiki, Ethereum Frontier Guide, the Ethereum Stack Exchange, or any other reputable source to relevant pages of the Homestead guide. Alternatively, write your own content for the guide based on experience.

Make sure the documentation you are porting over is still accurate and follows our guidelines for the Homestead docs (

Review What Has Been Written

Have a look at our guide ( and give us feedback by visiting our Gitter Chatroom ( or submit a pull request or issue to this repo. Too EZ.

What's In It For Me?

Your name will forever be immortalized, both in my heart and on the Contributors page in the guide. As a side effect, you may also get those good feels that you get when you help improve documentation :-)


This project uses Sphinx ( to build html that is published to Read the Docs. To run this documentation on your computer, you should do the following:


  • Python 2.6 or later
  • git

Install Sphinx, etc

For OSX/Linux users (based on instructions here:

  • From command line: sudo pip install sphinx

For Windows users:

Get source code

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



Legacy Docs

Read the Docs and Sphinx

Directory structure

  build    - workdir, not commited to repo
  source   - actual content in rst - sphinx configuration
  old-docs-for-reference (Frontier era stuff)
    wiki    - the legacy wiki
    gitbook - the legacy gitbook resources (converted to rst)
  make.bat - windows command to build docs
  Makefile - platforms with make to build docs

Roadmap for Homestead Guide (Old)

  • boilerplate using sphinx-quickstart
  • settings in
  • code up index with proposed structure
  • compile/deploy on readthedocs
  • include cheatsheat, rst/sphinx/readthedocs resources
  • reach out to community reddit - homestead documentation initiative
  • allocate chapters to people (ideally author and reviewer)
  • migrate old wiki under frontier/wiki (all md files converted to rst)
  • migrate old frontier-guide content under frontier/gitbook (all md content converted to rst)
  • script to annotate entire wiki with legacy warning

Strategy for migrating old fronter-guide content (Old)

  • temporaritly include resources about the documentation project within the book itself * rst cheatsheet * rst/sphinx/readthedocs resources * compilation/deployment instructions * link to issues and process * style guide, conventions
  • include the rst conversion of the wiki
  • include the rst conversion of the gitbook