Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ jobs:
fi
- name: Test
run: |
cargo make test -E 'test(test_all_templates_and_examples)'
cargo make test -E 'test(test_all_templates)'

miden_integration_node_tests:
name: miden integration node tests
Expand Down
27 changes: 0 additions & 27 deletions docs/external/src/usage/cargo-miden.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,6 @@ This will take a minute to compile, but once complete, you can run `cargo help m

To get help for a specific command, use `cargo miden help <command>` or `cargo miden <command> --help`.

## Creating an example project

If you're new to Miden and want to explore some example projects, you can use the `cargo miden example` command to create a project from one of our templates:

```bash
cargo miden example <example-name>
```

To see the list of available examples, run:

```bash
cargo miden example --help
```

Available examples include:

- **basic-wallet** - A basic wallet account implementation (creates both the wallet and a paired p2id-note)
- **p2id-note** - A pay-to-ID note script (creates both the note and a paired basic-wallet)
- **counter-contract** - A simple counter contract (creates both the contract and a paired counter-note)
- **counter-note** - A note script for interacting with the counter contract (creates both the note and paired counter-contract)
- **fibonacci** - A Fibonacci sequence calculator demonstrating basic computations
- **collatz** - An implementation of the Collatz conjecture
- **is-prime** - A prime number checker
- **storage-example** - Demonstrates storage operations in Miden

Note that some examples create paired projects. For instance, running `cargo miden example basic-wallet` will create a directory containing both the `basic-wallet` account and the `p2id-note` script that interacts with it.

## Creating a new project

Your first step will be to create a new Rust project set up for compiling to Miden:
Expand Down
4 changes: 1 addition & 3 deletions tools/cargo-miden/src/cli.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use clap::{Parser, Subcommand};

use crate::commands::{BuildCommand, ExampleCommand, NewCommand, TestCommand};
use crate::commands::{BuildCommand, NewCommand, TestCommand};

/// Top-level command-line interface for `cargo-miden`.
#[derive(Debug, Parser)]
Expand All @@ -23,8 +23,6 @@ pub enum CargoMidenCommand {
New(NewCommand),
/// Compile the current crate to Miden package.
Build(BuildCommand),
/// Scaffold one of the curated example projects.
Example(ExampleCommand),
/// Run the miden-tests in the project.
Test(TestCommand),
}
Loading