CodeChain monitoring tool
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
src
.editorconfig
.gitignore
.travis.yml
Cargo.toml
README.md
rustfmt.toml

README.md

CodeChain Agent Build Status

Requirements

The following are the software dependencies required to install and run CodeChain-agent:

Install dependencies (Ubuntu)

sudo apt install pkg-config libssl-dev

Run

To run CodeChain-agent, just run

cargo run -- --agent-hub-url <agent-hub-url> --codechain-dir <codechain-dir> --codechain-p2p-address <codechain-p2p-address> --name <name>

Formatting

Make sure you run rustfmt before creating a PR to the repo. You need to install the nightly-2018-07-17 version of rustfmt.

rustup toolchain install nightly-2018-07-17
rustup component add rustfmt-preview --toolchain nightly-2018-07-17

To run rustfmt,

cargo +nightly-2018-07-17 fmt

User Manual

Under docs folder, run following command.

make html

User manual will be generated at docs/_build/html.