This repository has been archived by the owner on Sep 18, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md: update build and run instructions
- Loading branch information
Showing
1 changed file
with
13 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -98,28 +98,29 @@ yarn test | |
|
||
### build | ||
|
||
requires `solc` to be in `$PATH`. [installation instructions](https://solidity.readthedocs.io/en/develop/installing-solidity.html) | ||
requires `rust` and `cargo`: [installation instructions.](https://www.rust-lang.org/en-US/install.html) | ||
|
||
requires `solc` to be in `$PATH`: [installation instructions.](https://solidity.readthedocs.io/en/develop/installing-solidity.html) | ||
|
||
assuming you've cloned the bridge (`git clone [email protected]:paritytech/parity-bridge.git`) | ||
and are in the project directory (`cd parity-bridge`) run: | ||
|
||
``` | ||
cargo build -p bridge-cli --release | ||
``` | ||
|
||
### cli options | ||
to install copy `../target/release/bridge` into a folder that's in your `$PATH`. | ||
|
||
``` | ||
Ethereum-Kovan bridge. | ||
Copyright 2017 Parity Technologies (UK) Limited | ||
### run | ||
|
||
Usage: | ||
bridge --config <config> --database <database> | ||
bridge -h | --help | ||
Options: | ||
-h, --help Display help message and exit. | ||
``` | ||
bridge --config config.toml --database db.toml | ||
``` | ||
|
||
- `--config` - location of the configuration file. configuration file must exist | ||
- `--database` - location of the database file. if there is no file at specified location, new bridge contracts will be deployed and new database will be created | ||
- `--database` - location of the database file. | ||
if there is no file at specified location, new bridge contracts will be deployed | ||
and new database will be created | ||
|
||
### configuration [file example](./examples/config.toml) | ||
|
||
|