fluencelabs/tendermint
1
0
Fork 0
mirror of https://github.com/fluencelabs/tendermint synced 2025-07-31 04:01:55 +00:00
Code Issues Projects Releases Wiki Activity

docs: logo, add readme, fixes

Browse Source
This commit is contained in:
Zach Ramsay
2017-09-01 19:42:23 -04:00
parent e509e8f354
commit f5ba931115
4 changed files with 36 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = Ethermint
SPHINXPROJ = Tendermint
SOURCEDIR = .
BUILDDIR = _build

14
docs/README.md Normal file
View File

@@ -0,0 +1,14 @@
Here lies our documentation. After making edits, run:
```
pip install -r requirements.txt
make html
```
to build the docs locally then open the file `_build/html/index.html` in your browser.
**WARNING:** This documentation is intended to be viewed at:
https://tendermint.readthedocs.io
and may contain broken internal links when viewed from Github.

BIN
docs/images/tmint-logo-blue.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

67
docs/index.rst
View File

@@ -3,13 +3,20 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Tendermint's documentation!
======================================
Welcome to Tendermint!
======================
Tendermint 101:
.. image:: images/tmint-logo-blue.png
:height: 500px
:width: 500px
:align: center
Tendermint 101
--------------
.. maxdepth set to 2 for sexiness
.. but use 4 to upgrade documentation
.. but use 4 to upgrade overall documentation
.. toctree::
:maxdepth: 2
@@ -19,7 +26,8 @@ Tendermint 101:
deploy-testnets.rst
using-tendermint.rst
Tendermint 102:
Tendermint 102
--------------
.. toctree::
:maxdepth: 2
@@ -28,50 +36,17 @@ Tendermint 102:
app-architecture.rst
app-development.rst
Tendermint 201:
Tendermint 201
--------------
.. toctree::
:maxdepth: 2
specification
specification.rst
Documentation (to refactor)
---------------------------
* 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.
* Readers 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 example applications and related software built by the Tendermint team and other, see the `software ecosystem <https://tendermint.com/ecosystem>`__.
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!
Next Steps
----------
Indices and tables
==================
:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`
Join the `Cosmos and Tendermint Rocket Chat <https://cosmos.rocket.chat>`__ to ask questions and discuss projects.