grin/doc/table_of_contents.md
Leo Young a73a54a10e [Done][doc] Chinese Translation (#3122)
* Create grin4bitcoiners_ZH-CN

* Rename grin4bitcoiners_ZH-CN to grin4bitcoiners_ZH-CN.md

* Create contract_ideas_ZH-CN.md

Chinese translation

* Create coinbase_maturity_ZH-CN.md

* Create contracts_ZH-CN.md

* Create stratum_ZH-CN.md

* Create switch_commitment_ZH-CN.md

* Create table_of_contents_ZH-CN.md

* Update contracts_ZH-CN.md

* Update contracts.md

* Chinese Translation added

* Update coinbase_maturity_ZH-CN.md

* Update coinbase_maturity.md

* Update switch_commitment_ZH-CN.md

* Update switch_commitment.md

* Update switch_commitment_ZH-CN.md

* Update switch_commitment_ZH-CN.md

* Update contracts_ZH-CN.md

* Update coinbase_maturity_ZH-CN.md

* Update table_of_contents_ZH-CN.md

* Create table_of_contents.md

* Delete table_of_contents_.md

* Update switch_commitment_ZH-CN.md

* Update stratum_ZH-CN.md

* Update stratum.md

* Update coinbase_maturity_ZH-CN.md

* Update coinbase_maturity_ZH-CN.md

* Update contracts_ZH-CN.md

* Update switch_commitment_ZH-CN.md
2020-01-08 10:53:47 -05:00

2.2 KiB

Documentation structure

Read this in other languages: Korean, 简体中文.

Explaining grin

  • intro - Technical introduction to grin
  • grin4bitcoiners - Explaining grin from a bitcoiner's perspective

Understand the grin implementation

  • chain_sync - About how Grin's blockchain is synchronized
  • blocks_and_headers - How Grin tracks blocks and headers on the chain
  • contract_ideas - Ideas on how to implement contracts
  • dandelion/dandelion - About transaction propagation and cut-through. Stemming and fluffing!
  • dandelion/simulation - Dandelion simulation - aggregating transaction without lock_height Stemming and fluffing!
  • internal/pool - Technical explanation of the transaction pool
  • merkle - Technical explanation of grin's favorite kind of merkle trees
  • merkle_proof graph - Example merkle proof with pruning applied
  • pruning - Technical explanation of pruning
  • stratum - Technical explanation of Grin Stratum RPC protocol
  • transaction UML - UML of an interactive transaction (aggregating transaction without lock_height)

Build and use

  • api - Explaining the different APIs in Grin and how to use them
  • build - Explaining how to build and run the Grin binaries
  • release - Instructions of making a release
  • usage - Explaining how to use grin in Testnet3
  • wallet - Explains the wallet design and grin wallet sub-commands

External (wiki)