From ab4bcb99b9e145807e56b4e2995b41c2fb04f486 Mon Sep 17 00:00:00 2001 From: Reddawn <35641620+forumevi@users.noreply.github.com> Date: Fri, 28 Aug 2026 00:40:03 +0300 Subject: [PATCH 1/3] Update README.md --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8e020e6c..e26718b5 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -# 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: +--- -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. +## 🚀 Prerequisites -## Documentation +Before running the examples, ensure you have installed the following toolchain dependencies: -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. +- **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](https://github.com/0xMiden/miden-client). +- **Cargo-make** (optional, for automation): `cargo install cargo-make` -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. +--- + +## 🛠️ Getting Started + +1. **Clone the repository:** + ```bash + git clone [https://github.com/0xMiden/miden-tutorials.git](https://github.com/0xMiden/miden-tutorials.git) + cd miden-tutorials From 2d50612b50cd76e2ae3a4ce8e645b39b84f02fdb Mon Sep 17 00:00:00 2001 From: Reddawn <35641620+forumevi@users.noreply.github.com> Date: Fri, 28 Aug 2026 00:43:03 +0300 Subject: [PATCH 2/3] Update README.md --- README.md | 46 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e26718b5..1b98c642 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,40 @@ -# Miden Tutorials & Quickstart Guides +Miden Tutorials & Quickstart Guides +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. -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. +Prerequisites +Before running the examples, ensure you have installed the following toolchain dependencies: ---- +Rust (latest stable version): curl --proto '=https' --tlsv1.2 -sSf [https://sh.rustup.rs](https://sh.rustup.rs) | sh -## 🚀 Prerequisites +Miden Client / CLI: Follow the installation guide in the Miden Client Repository. -Before running the examples, ensure you have installed the following toolchain dependencies: +Cargo-make (optional, for automation): cargo install cargo-make + +Getting Started +Clone the repository: +git clone https://github.com/0xMiden/miden-tutorials.git +cd miden-tutorials + +Build the examples: +cargo build --release + +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: -- **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](https://github.com/0xMiden/miden-client). -- **Cargo-make** (optional, for automation): `cargo install cargo-make` +Fork this repository. ---- +Create a feature branch: git checkout -b feature/new-tutorial -## 🛠️ Getting Started +Commit your changes: git commit -m 'Add new tutorial' -1. **Clone the repository:** - ```bash - git clone [https://github.com/0xMiden/miden-tutorials.git](https://github.com/0xMiden/miden-tutorials.git) - cd miden-tutorials +Push to the branch and open a Pull Request. From 100b942b1d541bbbfee862ce8ce32374945232f1 Mon Sep 17 00:00:00 2001 From: Reddawn <35641620+forumevi@users.noreply.github.com> Date: Fri, 28 Aug 2026 00:44:35 +0300 Subject: [PATCH 3/3] Update README.md --- README.md | 50 ++++++++++++++++++++++++-------------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 1b98c642..2d3fec19 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,38 @@ -Miden Tutorials & Quickstart Guides +# Miden Tutorials & Quickstart Guides + 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. -Prerequisites -Before running the examples, ensure you have installed the following toolchain dependencies: +## Prerequisites -Rust (latest stable version): curl --proto '=https' --tlsv1.2 -sSf [https://sh.rustup.rs](https://sh.rustup.rs) | sh +Before running the examples, ensure you have installed the following toolchain dependencies: -Miden Client / CLI: Follow the installation guide in the Miden Client Repository. +* **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` -Cargo-make (optional, for automation): cargo install cargo-make +## Getting Started -Getting Started -Clone the repository: -git clone https://github.com/0xMiden/miden-tutorials.git -cd miden-tutorials +1. **Clone the repository:** + `git clone https://github.com/0xMiden/miden-tutorials.git` + `cd miden-tutorials` -Build the examples: -cargo build --release +2. **Build the examples:** + `cargo build --release` -Run a basic VM test transaction: -cargo test +3. **Run a basic VM test transaction:** + `cargo test` -Resources & Documentation -Official Documentation: https://docs.miden.xyz +## Resources & Documentation -Miden VM Repository: https://github.com/0xMiden/miden-vm +* **Official Documentation:** https://docs.miden.xyz +* **Miden VM Repository:** https://github.com/0xMiden/miden-vm +* **Discord Community:** https://discord.gg/polygon -Discord Community: https://discord.gg/polygon +## Contributing -Contributing Contributions are welcome! If you find any issues, broken examples, or want to add a new tutorial: -Fork this repository. - -Create a feature branch: git checkout -b feature/new-tutorial - -Commit your changes: git commit -m 'Add new tutorial' - -Push to the branch and open a Pull Request. +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.