tendermint/docs/index.rst

78 lines
2.4 KiB
ReStructuredText
Raw Normal View History

2017-08-30 16:16:15 -07:00
.. Tendermint documentation master file, created by
sphinx-quickstart on Mon Aug 7 04:55:09 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Tendermint's documentation!
2017-08-30 18:01:05 -07:00
======================================
2017-08-30 16:16:15 -07:00
Tendermint 101:
.. maxdepth set to 2 for sexiness
.. but use 4 to upgrade documentation
.. toctree::
2017-08-30 19:36:16 -07:00
:maxdepth: 2
2017-08-30 16:16:15 -07:00
introduction.rst
install-from-source.rst
getting-started.rst
deploy-testnets.rst
using-tendermint.rst
Tendermint 102:
.. toctree::
2017-08-30 19:36:16 -07:00
:maxdepth: 2
2017-08-30 16:16:15 -07:00
abci-cli.rst
app-architecture.rst
app-development.rst
Tendermint 201:
.. toctree::
2017-08-30 18:17:07 -07:00
:maxdepth: 2
2017-08-30 16:16:15 -07:00
specification
Documentation (to refactor)
2017-08-30 18:01:05 -07:00
---------------------------
2017-06-20 12:58:26 -07:00
If you're new here, start with the [Tendermint Intro](/intro).
To start building an ABCI application and integrating with Tendermint,
see the [App Development](/docs/guides/app-development)
and [App Architecture](/docs/guides/app-architecture) guides.
To learn more about running the Tendermint software, see the [Using Tendermint Guide](/docs/guides/using-tendermint).
To learn more about Tendermint's various pieces, check out the [Documentation](/docs).
For a deeper dive, see [this thesis](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769).
There is also the [original whitepaper](https://tendermint.com/static/docs/tendermint.pdf), though it is now quite outdated.
You might also be interested in the [Cosmos Whitepaper](https://cosmos.network/whitepaper),
which describes Tendermint, ABCI, and how to build a scalable, heterogeneous, cryptocurrency network.
For details on how the software has changed, and what changes are in store, see the [Changelog](https://github.com/tendermint/tendermint/blob/master/CHANGELOG.md) and the [Roadmap](https://github.com/tendermint/tendermint/blob/master/roadmap.md).
If you're interested in contributing, see our [Contributor Guidelines](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md)
The Tendermint [Software Ecosystem](/ecosystem) contains many example applications and related software built by the Tendermint team and others.
Check it out for some motivation and inspiration!
See our [Community](/community) page for more ways to collaborate.
You can also [get in touch with the team](/contact).
Most importantly, enjoy!
2017-08-30 14:54:25 -07:00
Next Steps
----------
2017-08-30 16:16:15 -07:00
Indices and tables
==================
:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`