Skip to content

Commit dec6f07

Browse files
authored
Merge pull request #914 from 0xMiden/i857-remove-miden-example
[3/x] chore: remove `cargo miden example` command
2 parents 7856355 + 3305882 commit dec6f07

File tree

7 files changed

+3
-689
lines changed

7 files changed

+3
-689
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ jobs:
290290
fi
291291
- name: Test
292292
run: |
293-
cargo make test -E 'test(test_all_templates_and_examples)'
293+
cargo make test -E 'test(test_all_templates)'
294294
295295
miden_integration_node_tests:
296296
name: miden integration node tests

docs/external/src/usage/cargo-miden.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -37,33 +37,6 @@ This will take a minute to compile, but once complete, you can run `cargo help m
3737

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

40-
## Creating an example project
41-
42-
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:
43-
44-
```bash
45-
cargo miden example <example-name>
46-
```
47-
48-
To see the list of available examples, run:
49-
50-
```bash
51-
cargo miden example --help
52-
```
53-
54-
Available examples include:
55-
56-
- **basic-wallet** - A basic wallet account implementation (creates both the wallet and a paired p2id-note)
57-
- **p2id-note** - A pay-to-ID note script (creates both the note and a paired basic-wallet)
58-
- **counter-contract** - A simple counter contract (creates both the contract and a paired counter-note)
59-
- **counter-note** - A note script for interacting with the counter contract (creates both the note and paired counter-contract)
60-
- **fibonacci** - A Fibonacci sequence calculator demonstrating basic computations
61-
- **collatz** - An implementation of the Collatz conjecture
62-
- **is-prime** - A prime number checker
63-
- **storage-example** - Demonstrates storage operations in Miden
64-
65-
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.
66-
6740
## Creating a new project
6841

6942
Your first step will be to create a new Rust project set up for compiling to Miden:

tools/cargo-miden/src/cli.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use clap::{Parser, Subcommand};
22

3-
use crate::commands::{BuildCommand, ExampleCommand, NewCommand, TestCommand};
3+
use crate::commands::{BuildCommand, NewCommand, TestCommand};
44

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

0 commit comments

Comments
 (0)