This mdbook aims to provide insights into the future of the Miden protocol.
You can find a live website of the Miden research book here
To run the mdbook locally, follow these steps:
-
Make sure you have Rust installed on your system. If not, you can install it from https://www.rust-lang.org/tools/install.
-
Install mdbook by running the following command:
cargo install mdbook -
Clone this repository:
git clone https://github.com/your-username/miden-research.git cd miden-research -
Build and serve the book:
mdbook serve --open
This command will build the book and open it in your default web browser. The --open flag automatically opens the book in your browser.
Once you have the mdbook running, you can read it in the following ways:
-
Local Browser: If you're running the book locally using
mdbook serve, it will be available athttp://localhost:3000by default. -
Navigation: Use the sidebar on the left to navigate between different chapters and sections of the book.
-
Search: Utilize the search bar at the top to find specific topics or keywords within the book.
-
Offline Reading: You can also generate a static version of the book for offline reading:
mdbook buildThis will create a
bookdirectory with HTML files that you can open in any web browser.
We welcome contributions to this research. Please feel free to submit pull requests or open issues for discussion.
This project is licensed under the MIT License.