Merge pull request 'docs:update readme' (#1) from docs/update-readme into master

Reviewed-on: https://git.trustie.net/openatom_foundation/bitxhub/pulls/1
This commit is contained in:
hyperchain 2021-05-08 12:12:47 +08:00
commit 7897eac978
2 changed files with 34 additions and 8 deletions

View File

@ -11,22 +11,48 @@ reference implementation, that can provide reliable technical support for the fo
of a blockchain internet and intercommunication of value islands.
## Quick start
See [Quick start](https://github.com/meshplus/bitxhub/wiki/Quick-start) in the wiki.
## Architecture
<p>
<img src="https://raw.githubusercontent.com/meshplus/bitxhub/master/docs/arch.png" />
</p>
The diagram above shows the overall architecture and basic interchain processing workflow of BitXHub. BitXHub consists of relay-chain, Pier (interchain gateway) and app-chain, which is a service platform to handle the interaction among cross-layer heterogeneous chains.
![](docs/docs/assets/bitxhub-arch.png)
The diagram above shows the overall architecture which is a service platform to handle the interaction among cross-layer heterogeneous chains.
For more details please visit our [whitepaper](https://upload.hyperchain.cn/BitXHub%20Whitepaper.pdf) | [白皮书](https://upload.hyperchain.cn/BitXHub%E7%99%BD%E7%9A%AE%E4%B9%A6.pdf).
# Start BitXHub
Requirements
- OS Support: Linux and Mac OS
- Go 1.13.x or later
- Tmux
- Git
BitXHub start script relies on [golang](https://golang.org/) and [tmux](https://github.com/tmux/tmux/wiki). Please
install the software before start.
Use commands below to clone the project:
```shell
git clone https://git.trustie.net/openatom_foundation/bitxhub.git
```
BitXHub also relies on some small tools, use commands below to install:
```shell
cd bitxhub
bash scripts/prepare.sh
git checkout -f v1.0.0-rc1
```
Finally, run the following commands to start a four nodes relay-chain.
```shell
make cluster
```
**Noting:** `make cluster` will use `tmux` to split the screen. Thus, during commands processing, better not switch the terminal.
## Usage

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB