-
Notifications
You must be signed in to change notification settings - Fork 359
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added README page to the guide with instructions. Fix index page (#542)
- Loading branch information
Showing
4 changed files
with
62 additions
and
2 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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Relayer CLI Guide | ||
|
||
In order to build and view the Relayer CLI guide you need to instal [`mdBook`](https://github.com/rust-lang/mdBook). | ||
|
||
mdBook is a utility to create modern online books from Markdown files. | ||
|
||
### Pre-requisites | ||
|
||
Install `mdBook` using [`cargo`](https://doc.rust-lang.org/cargo/): | ||
|
||
```bash | ||
cargo install mdbook | ||
``` | ||
|
||
You also need to install the mdbook plug-in for [`mermaid`](https://mermaid-js.github.io/mermaid/#/) to generate graphs and diagrams: | ||
|
||
```bash | ||
cargo install mdbook-mermaid | ||
``` | ||
|
||
### Building and viewing the guide locally | ||
|
||
In order to build and view the guide on your local machine, please follow this instructions. | ||
|
||
#### Change to the `guide` dir | ||
|
||
This assumes your current dir is the `ibc-rs` repository | ||
|
||
```bash | ||
cd guide | ||
``` | ||
|
||
#### Build the guide | ||
|
||
To build and view the guide in your browser, run the `mdbook` command below: | ||
|
||
```bash | ||
mdbook serve | ||
``` | ||
|
||
#### View the guide | ||
|
||
This will host the guide in your local machine. Open your browser and navigate to: | ||
|
||
```bash | ||
http://localhost:3000 | ||
``` | ||
|
||
### Adding or editing new content to the guide | ||
|
||
Please check the [mdBook documentation](https://rust-lang.github.io/mdBook/index.html) for additional information on how to add new content to the guide. | ||
|
||
Basically if you want to add new content to the guide, just add an entry to the `SUMMARY.md` Markdown file which is the TOC page. Then create a page for the entry you've added to the `SUMMARY.md` page. If you don't create the page, but save the `SUMMARY.md` file and build again, `mdBook` will create the page automatically for you. | ||
|
||
#### Local development | ||
If you are adding content using your favorite IDE and have a terminal opened running `mdbook serve`, it provides a convenient watch functionality so any changes detected on local files will trigger another build and if you refresh the guide on your browser they will be shown there. | ||
|
||
#### Submit your changes | ||
Once you finish adding the new content just commit your changes (`git commit`) and push them to the respository (`git push`). |
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
File renamed without changes.
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
# What is a relayer? |