Skip to content

docs: improve README structure with prerequisites and setup steps #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
forumevi wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: improve README structure with prerequisites and setup steps #246

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab4bcb9
Update README.md
forumevi Aug 27, 2026
2d50612
Update README.md
forumevi Aug 27, 2026
100b942
Update README.md
forumevi Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 32 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@
# miden-tutorials
# Miden Tutorials & Quickstart Guides

The goal of this repository is to provide clear and practical examples for interacting with the **Miden Rollup**. These examples are designed to ensure a smooth onboarding experience for developers exploring Miden's capabilities.
Welcome to the Miden Tutorials repository! This repository contains quickstart examples, smart contract execution flows, and guides to help developers build zero-knowledge applications on the Polygon Miden platform.

This repository is organized into several parts:
## Prerequisites

1. **docs**, contains the README files for the tutorials and guides.
2. **examples**, contains complete example projects (e.g., the Miden Bank built with the Rust compiler).
3. **masm**, contains the Miden assembly notes, accounts, and scripts used in the examples.
4. **rust-client**, contains examples for interacting with the Miden Rollup using **Rust**.
5. **web-client**, contains examples for interacting with the Miden Rollup in the browser.
Before running the examples, ensure you have installed the following toolchain dependencies:

## Documentation
* **Rust** (latest stable version): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
* **Miden Client / CLI**: Follow the installation guide in the Miden Client Repository.
* **Cargo-make** (optional, for automation): `cargo install cargo-make`

The documentation (tutorials) in the `docs` folder is built using Docusaurus and is automatically absorbed into the main [miden-docs](https://github.com/0xMiden/miden-docs) repository for the main documentation website. Changes to the `next` branch trigger an automated deployment workflow. The docs folder requires npm packages to be installed before building.
## Getting Started

The documentation folder is also a standalone Rust repository. The purpose of this is to be able to run `cargo doc test`, to test the Rust code inside of the tutorial markdowns.
1. **Clone the repository:**
`git clone https://github.com/0xMiden/miden-tutorials.git`
`cd miden-tutorials`

2. **Build the examples:**
`cargo build --release`

3. **Run a basic VM test transaction:**
`cargo test`

## Resources & Documentation

* **Official Documentation:** https://docs.miden.xyz
* **Miden VM Repository:** https://github.com/0xMiden/miden-vm
* **Discord Community:** https://discord.gg/polygon

## Contributing

Contributions are welcome! If you find any issues, broken examples, or want to add a new tutorial:

1. Fork this repository.
2. Create a feature branch: `git checkout -b feature/new-tutorial`
3. Commit your changes: `git commit -m 'Add new tutorial'`
4. Push to the branch and open a Pull Request.