Skip to content

Commit

Permalink
updated the readme to build and access
Browse files Browse the repository at this point in the history
  • Loading branch information
mshankarrao authored Oct 9, 2023
1 parent 60b41bf commit 53ebe8d
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
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

0 comments on commit 53ebe8d

Please sign in to comment.