Skip to content
This repository has been archived by the owner on Aug 4, 2021. It is now read-only.

riversyang/homestead-guide-cn

Repository files navigation

*************************** Homestead-Guide-CN(Homestead指南中文版)*************************** The Ethereum Homestead Guide-CN is the Chinese version of the reference documentation accompanying the Homestead release of the Ethereum project, which is an unofficial project created by Rivers Yang, a programmer with 15+ years experience in software technology.

The Original English version is Hosted on ReadTheDocs

HOW YOU CAN HELP

I start this project just for my personal interest and for the tech learning in Smart Contract (Blockchain) area. I welcome any contributor for this project, and you better are Chinese too. :-)

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). Sphinx as of 1.4.0 no longer automatically installs sphinx_rtd_theme, hence its addition below.

  • From command line: sudo pip install sphinx sphinx_rtd_theme

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

RESOURCES

Homestead

Legacy Docs

Read the Docs and Sphinx

Directory structure

homestead-guide
  build    - workdir, not commited to repo
  source   - actual content in rst
    conf.py - 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 conf.py
  • 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

About

Chinese version of homestead-guide, translated by Rivers Yang

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published