Skip to content

Commit

Permalink
Fixing some content to show hermes (#542)
Browse files Browse the repository at this point in the history
  • Loading branch information
andynog committed Jan 31, 2021
1 parent a0a79ff commit c3600f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion guide/src/config.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration

In order to run the relayer, you will need to have a configuration file.
In order to run `Hermes`, you will need to have a configuration file.

The format supported for the configuration file is [TOML](https://toml.io/en/)

Expand Down
18 changes: 9 additions & 9 deletions guide/src/setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building the Relayer

In order to build and run the relayer, please follow the steps below:
In order to build and run Hermes, please follow the steps below:

> NOTE: This assumes you have installed all the [pre-requisites](./pre-requisites.md) on your machine.
Expand Down Expand Up @@ -29,29 +29,29 @@ git checkout v0.1.0

### Building with `cargo build`

This command will build all the projects from the [__`ibc-rs`__](https://github.com/informalsystems/ibc-rs) repository including the [__`IBC modules`__](https://github.com/informalsystems/ibc-rs/tree/master/modules) crate, [__`relayer`__](https://github.com/informalsystems/ibc-rs/tree/master/relayer) crate, [__`proto`__](https://github.com/informalsystems/ibc-rs/tree/master/proto) crate, and the [__`relayer-cli`__](https://github.com/informalsystems/ibc-rs/tree/master/relayer-cli) tool.
This command will build all the projects from the [__`ibc-rs`__](https://github.com/informalsystems/ibc-rs) repository including the [__`ibc`__](https://github.com/informalsystems/ibc-rs/tree/master/modules) modules crate, [__`ibc-relayer`__](https://github.com/informalsystems/ibc-rs/tree/master/relayer) crate, [__`proto`__](https://github.com/informalsystems/ibc-rs/tree/master/proto) crate, and the [__`ibc-relayer-cli`__](https://github.com/informalsystems/ibc-rs/tree/master/relayer-cli) tool.

```shell
cargo build --workspace --all --release
```

If the build is successful, the `relayer` executable will be located in the following location:
If the build is successful, the `hermes` executable will be located in the following location:

```shell
./target/release/relayer
./target/release/hermes
```

### Running for the first time

If you run the `relayer` without any additional parameters you should see the usage and help information:
If you run the `hermes` without any additional parameters you should see the usage and help information:

```shell
$ ./target/release/relayer
relayer-cli 0.1.0
$ ./target/release/hermes
ibc-relayer-cli 0.1.0
Informal Systems <hello@informal.systems>
USAGE:
relayer-cli <SUBCOMMAND>
ibc-relayer-cli <SUBCOMMAND>
SUBCOMMANDS:
help get usage information
Expand All @@ -67,4 +67,4 @@ SUBCOMMANDS:

### Next Steps

Next, go to the [`Configuration`](./config.md) section to learn how to create a configuration file to be used by the relayer.
Next, go to the [`Configuration`](./config.md) section to learn how to create a configuration file to be used by `Hermes`.

0 comments on commit c3600f9

Please sign in to comment.