From 53ebe8d71530d7672dbc97fe476c80b036c759e3 Mon Sep 17 00:00:00 2001 From: Evolution Date: Mon, 9 Oct 2023 13:36:27 -0400 Subject: [PATCH] updated the readme to build and access --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a52f03c --- /dev/null +++ b/README.md @@ -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 +