2020-06-09 16:40:18 +00:00
|
|
|
# Contribute
|
|
|
|
|
|
2020-06-19 13:55:11 +00:00
|
|
|
Follow these steps to contribute to this book!
|
2020-06-09 16:50:10 +00:00
|
|
|
|
|
|
|
|
We use an utility tool called mdBook to create online books from Markdown files.
|
2020-06-09 16:40:18 +00:00
|
|
|
|
|
|
|
|
## Before You Start
|
|
|
|
|
|
|
|
|
|
1. Install mdBook from [here](https://github.com/rust-lang/mdBook).
|
|
|
|
|
2. Clone the repository by `git clone https://github.com/status-im/nim-beacon-chain.git`.
|
|
|
|
|
3. Go to where the Markdown files are located by `cd docs`.
|
|
|
|
|
|
|
|
|
|
## Real-Time Update and Preview Changes
|
|
|
|
|
|
|
|
|
|
1. Run `mdbook serve` in the terminal.
|
|
|
|
|
2. Preview the book at [http://localhost:3000](http://localhost:3000).
|
|
|
|
|
|
|
|
|
|
## Build and Deploy
|
|
|
|
|
|
2020-06-19 13:55:11 +00:00
|
|
|
The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nim-beacon-chain/tree/devel).
|
|
|
|
|
Then, after it is merged, do the following under our main repository:
|
|
|
|
|
|
|
|
|
|
1. `cd nim-beacon-chain`
|
|
|
|
|
2. `git checkout devel`
|
|
|
|
|
3. `git pull`
|
|
|
|
|
4. `make update` (This is to update the submodules to the latest version)
|
|
|
|
|
5. `make publish-book`
|
2020-06-09 16:40:18 +00:00
|
|
|
|
|
|
|
|
Thank you so much for your help to the decentralized and open source community. :)
|
