mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
moar fixes
This commit is contained in:
parent
ffa8b5f620
commit
e82ab1c374
2
.gitignore
vendored
2
.gitignore
vendored
@ -15,7 +15,7 @@ test/logs
|
|||||||
coverage.txt
|
coverage.txt
|
||||||
docs/_build
|
docs/_build
|
||||||
docs/tools
|
docs/tools
|
||||||
docs/abci-spec.rst
|
docs/abci-spec.md
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
scripts/wal2json/wal2json
|
scripts/wal2json/wal2json
|
||||||
|
@ -1,4 +1,6 @@
|
|||||||
# Supported tags and respective `Dockerfile` links
|
# Docker
|
||||||
|
|
||||||
|
## Supported tags and respective `Dockerfile` links
|
||||||
|
|
||||||
- `0.17.1`, `latest` [(Dockerfile)](https://github.com/tendermint/tendermint/blob/208ac32fa266657bd6c304e84ec828aa252bb0b8/DOCKER/Dockerfile)
|
- `0.17.1`, `latest` [(Dockerfile)](https://github.com/tendermint/tendermint/blob/208ac32fa266657bd6c304e84ec828aa252bb0b8/DOCKER/Dockerfile)
|
||||||
- `0.15.0` [(Dockerfile)](https://github.com/tendermint/tendermint/blob/170777300ea92dc21a8aec1abc16cb51812513a4/DOCKER/Dockerfile)
|
- `0.15.0` [(Dockerfile)](https://github.com/tendermint/tendermint/blob/170777300ea92dc21a8aec1abc16cb51812513a4/DOCKER/Dockerfile)
|
||||||
@ -14,7 +16,7 @@
|
|||||||
|
|
||||||
`develop` tag points to the [develop](https://github.com/tendermint/tendermint/tree/develop) branch.
|
`develop` tag points to the [develop](https://github.com/tendermint/tendermint/tree/develop) branch.
|
||||||
|
|
||||||
# Quick reference
|
## Quick reference
|
||||||
|
|
||||||
* **Where to get help:**
|
* **Where to get help:**
|
||||||
https://cosmos.network/community
|
https://cosmos.network/community
|
||||||
@ -25,7 +27,7 @@
|
|||||||
* **Supported Docker versions:**
|
* **Supported Docker versions:**
|
||||||
[the latest release](https://github.com/moby/moby/releases) (down to 1.6 on a best-effort basis)
|
[the latest release](https://github.com/moby/moby/releases) (down to 1.6 on a best-effort basis)
|
||||||
|
|
||||||
# Tendermint
|
## Tendermint
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@ -33,9 +35,9 @@ For more background, see the [introduction](https://tendermint.readthedocs.io/en
|
|||||||
|
|
||||||
To get started developing applications, see the [application developers guide](https://tendermint.readthedocs.io/en/master/getting-started.html).
|
To get started developing applications, see the [application developers guide](https://tendermint.readthedocs.io/en/master/getting-started.html).
|
||||||
|
|
||||||
# How to use this image
|
## How to use this image
|
||||||
|
|
||||||
## Start one instance of the Tendermint core with the `kvstore` app
|
### Start one instance of the Tendermint core with the `kvstore` app
|
||||||
|
|
||||||
A quick example of a built-in app and Tendermint core in one container.
|
A quick example of a built-in app and Tendermint core in one container.
|
||||||
|
|
||||||
@ -44,7 +46,7 @@ docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
|
|||||||
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy_app=kvstore
|
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy_app=kvstore
|
||||||
```
|
```
|
||||||
|
|
||||||
# Local cluster
|
## Local cluster
|
||||||
|
|
||||||
To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/tendermint/tendermint/master/Makefile) and run:
|
To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/tendermint/tendermint/master/Makefile) and run:
|
||||||
|
|
||||||
@ -56,10 +58,10 @@ make localnet-start
|
|||||||
|
|
||||||
Note that this will build and use a different image than the ones provided here.
|
Note that this will build and use a different image than the ones provided here.
|
||||||
|
|
||||||
# License
|
## License
|
||||||
|
|
||||||
- Tendermint's license is [Apache 2.0](https://github.com/tendermint/tendermint/master/LICENSE).
|
- Tendermint's license is [Apache 2.0](https://github.com/tendermint/tendermint/master/LICENSE).
|
||||||
|
|
||||||
# Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are most welcome! See the [contributing file](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md) for more information.
|
Contributions are most welcome! See the [contributing file](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md) for more information.
|
||||||
|
@ -300,8 +300,8 @@ Monax's permissioning scheme, and native contracts extensions.
|
|||||||
But the ultimate flexibility comes from being able to write the
|
But the ultimate flexibility comes from being able to write the
|
||||||
application easily in any language.
|
application easily in any language.
|
||||||
|
|
||||||
We have implemented the counter in a number of languages (see the
|
We have implemented the counter in a number of languages [see the
|
||||||
example directory <https://github.com/tendermint/abci/tree/master/example\_\_).
|
example directory](https://github.com/tendermint/abci/tree/master/example).
|
||||||
|
|
||||||
To run the Node JS version, `cd` to `example/js` and run
|
To run the Node JS version, `cd` to `example/js` and run
|
||||||
|
|
||||||
|
20
docs/conf.py
20
docs/conf.py
@ -41,8 +41,15 @@ templates_path = ['_templates']
|
|||||||
# The suffix(es) of source filenames.
|
# The suffix(es) of source filenames.
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
#
|
#
|
||||||
#source_suffix = ['.rst', '.md']
|
|
||||||
source_suffix = '.rst'
|
from recommonmark.parser import CommonMarkParser
|
||||||
|
|
||||||
|
source_parsers = {
|
||||||
|
'.md': CommonMarkParser,
|
||||||
|
}
|
||||||
|
|
||||||
|
source_suffix = ['.rst', '.md']
|
||||||
|
#source_suffix = '.rst'
|
||||||
|
|
||||||
# The master toctree document.
|
# The master toctree document.
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
@ -173,21 +180,20 @@ texinfo_documents = [
|
|||||||
|
|
||||||
# ---------------- customizations ----------------------
|
# ---------------- customizations ----------------------
|
||||||
|
|
||||||
# Docker README
|
# for Docker README, below
|
||||||
from shutil import copyfile
|
from shutil import copyfile
|
||||||
|
|
||||||
copyfile('../DOCKER/README.md', tools_dir+'docker.md')
|
|
||||||
|
|
||||||
# tm-bench and tm-monitor
|
# tm-bench and tm-monitor
|
||||||
tools_repo = "https://raw.githubusercontent.com/tendermint/tools/"
|
tools_repo = "https://raw.githubusercontent.com/tendermint/tools/"
|
||||||
tools_branch = "master"
|
tools_branch = "master"
|
||||||
|
|
||||||
tools_dir = "./tools"
|
tools_dir = "./tools"
|
||||||
|
|
||||||
|
|
||||||
if os.path.isdir(tools_dir) != True:
|
if os.path.isdir(tools_dir) != True:
|
||||||
os.mkdir(tools_dir)
|
os.mkdir(tools_dir)
|
||||||
if os.path.isdir(assets_dir) != True:
|
|
||||||
os.mkdir(assets_dir)
|
copyfile('../DOCKER/README.md', tools_dir+'/docker.md')
|
||||||
|
|
||||||
urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.md', filename=tools_dir+'/benchmarking.md')
|
urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.md', filename=tools_dir+'/benchmarking.md')
|
||||||
urllib.urlretrieve(tools_repo+tools_branch+'/tm-monitor/README.md', filename=tools_dir+'/monitoring.md')
|
urllib.urlretrieve(tools_repo+tools_branch+'/tm-monitor/README.md', filename=tools_dir+'/monitoring.md')
|
||||||
|
@ -37,10 +37,11 @@ Tendermint Tools
|
|||||||
.. the tools/ files are pulled in from the tools repo
|
.. the tools/ files are pulled in from the tools repo
|
||||||
.. see the bottom of conf.py
|
.. see the bottom of conf.py
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
deploy-testnets.md
|
deploy-testnets.md
|
||||||
terraform-and-ansible.md
|
terraform-and-ansible.md
|
||||||
|
tools/docker.md
|
||||||
tools/benchmarking.md
|
tools/benchmarking.md
|
||||||
tools/monitoring.md
|
tools/monitoring.md
|
||||||
|
|
||||||
@ -67,10 +68,11 @@ Tendermint 201
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
specification.md
|
|
||||||
determinism.md
|
determinism.md
|
||||||
transactional-semantics.md
|
transactional-semantics.md
|
||||||
|
|
||||||
|
.. specification.md
|
||||||
|
|
||||||
* For a deeper dive, see `this thesis <https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769>`__.
|
* 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.
|
* 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.
|
* 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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user