Browse Source

docs readme is vuepress landing page

pull/1800/head
Zach Ramsay 7 years ago
parent
commit
c1548c7861
1 changed files with 12 additions and 9 deletions
  1. +12
    -9
      docs/README.md

+ 12
- 9
docs/README.md View File

@ -1,14 +1,17 @@
Here lies our documentation. After making edits, run:
# Tendermint
```
pip install -r requirements.txt
make html
```
Welcome to the Tendermint Core documentation! The introduction below provides an overview to help you navigate to your area of interest.
to build the docs locally then open the file `_build/html/index.html` in your browser.
## Introduction
**WARNING:** This documentation is intended to be viewed at:
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language - and securely replicates it on many machines. In other words, a blockchain.
https://tendermint.readthedocs.io
Tendermint requires an application running over the Application Blockchain Interface (ABCI) - and comes packaged with an example application to do so. Follow the [installation instructions](./install) to get up and running quickly. For more details on [using tendermint](./using-tendermint) see that and the following sections.
and may contain broken internal links when viewed from Github.
## Networks
Testnets can be setup manually on one or more machines, or automatically on one or more machine, using a variety of methods described in the [deploy testnets section](./deploy-testnets). For more information (and to join) about the Cosmos Network testnets, see [here](link).
## Application Development
The first step to building application on Tendermint is to [install ABCI-CLI](./getting-started) and play with the example applications.

Loading…
Cancel
Save