Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #81

Merged
merged 3 commits into from
Jul 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
uses: actions/checkout@v2

- name: Starport build
run: starport build
run: starport chain build

build-node-and-testnet-images:
name: Build node and testnet images
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
uses: actions/checkout@v2

- name: Build
run: starport build
run: starport chain build

- name: Create artifacts directory
run: mkdir ${{ env.OUTPUT_DIR }}
Expand Down
38 changes: 33 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,49 @@

verim is a blockchain built using Cosmos SDK and Tendermint and created with [Starport](https://github.com/tendermint/starport).

## Get started
## Building node from source

Prerequisites:

- Install [Go](https://golang.org/doc/install)
- Install [Starport](https://docs.starport.network/intro/install.html)

To build the node executable run:

```
starport chain build
```

To look up binary's location run:

```
which verim-noded
```

## Building node in docker

Use this [instruction](ci/docker/README.md).

## Running local network using starport

Prerequisites:

- Install [Go](https://golang.org/doc/install)
- Install [Starport](https://docs.starport.network/intro/install.html)

Only the network of one node is supported. To run the network of one node:

```
starport serve
```

`serve` command installs dependencies, builds, initializes and starts your blockchain in development.

## Configure

Your blockchain in development can be configured with `config.yml`. To learn more see the [reference](https://github.com/tendermint/starport#documentation).

## Launch
## Running local network using docker

To launch your blockchain live on mutliple nodes use `starport network` commands. Learn more about [Starport Network](https://github.com/tendermint/spn).
Use this [instruction](ci/local_net/README.md).

## Learn more

Expand Down
2 changes: 1 addition & 1 deletion ci/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ COPY x ./x
COPY go.mod .
COPY go.sum .

RUN starport build
RUN starport chain build


##### Run container #####
Expand Down
2 changes: 1 addition & 1 deletion ci/docker_testnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Debian based docker image with the latest version of `verim-nonded` executable and preconfigured network of 4 nodes. Intended for use in CI pipelines.
Debian based docker image with the latest version of `verim-nonded` executable and preconfigured network of 2 nodes. Intended for use in CI pipelines.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion ci/local_net/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The set of scripts to generate configuration for a testnet of four nodes and run
2. Build verim-noded:

```
starport build
starport chain build
```

3. Generate node configurations:
Expand Down
113 changes: 0 additions & 113 deletions docs/how-to-add-new-node.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/how-to-run-local-testnet-in-docker.md

This file was deleted.

Loading