-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #302 from 0xPolygonMiden/greenhat/fix-mkdocs-warnings
chore: fix mkdocs warnings, move cargo-miden README to docs
- Loading branch information
Showing
5 changed files
with
50 additions
and
44 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Miden Cargo Extension | ||
|
||
`cargo-miden` crate provides a cargo extension that allows you to compile Rust code to Miden VM MASM. | ||
|
||
## Installation | ||
|
||
In order to install(build) the extension, you need to have the nightly Rust toolchain installed: | ||
|
||
```bash | ||
rustup toolchain install nightly-2024-05-07 | ||
``` | ||
|
||
To install the extension, run: | ||
|
||
```bash | ||
cargo +nightly-2024-05-07 install cargo-miden | ||
``` | ||
|
||
## Usage | ||
|
||
### Getting help | ||
To get help with the extension, run: | ||
|
||
```bash | ||
cargo miden | ||
``` | ||
|
||
Or for help with a specific command: | ||
|
||
```bash | ||
cargo miden <command> --help | ||
``` | ||
|
||
### Creating a new project | ||
To create a new Miden VM project, run: | ||
|
||
```bash | ||
cargo miden new <project-name> | ||
``` | ||
|
||
### Compiling a project | ||
To compile a Rust crate to Miden VM MASM, run: | ||
|
||
```bash | ||
cargo miden build | ||
``` | ||
|
||
Without any additional arguments, this will compile the library target in the target directory in the `miden` folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters