-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated the readme to build and access
- Loading branch information
1 parent
60b41bf
commit 53ebe8d
Showing
1 changed file
with
25 additions
and
0 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,25 @@ | ||
# vane-book | ||
|
||
## Book about vane | ||
|
||
- [Follow this to access the book](https://globalboost.github.io/impactprotocol-book/) | ||
- [Our Github Repo](https://github.com/2-5-Foundation) | ||
|
||
## Work on adding an improving this document | ||
|
||
### Install mdbook | ||
|
||
- cargo install mdbook | ||
|
||
### Generate the static docs locally | ||
|
||
Add/Edit the document and test it locally. Create PR to be merged in the main branch | ||
|
||
- mdbook build | ||
|
||
### Run locally and check the book | ||
|
||
- mdbook serve | ||
Type localhost:3000 in your browser and verify | ||
|