## Table of Contents * [1. Overview](#1-overview) * [2. Build Guide](#2-build-guide) * [3. Usage Guide](#3-usage-guide) * [4. Contributors](#4-contributors) * [5. License](#5-license) ## 1. Overview | Package | Crate.io | `std` | `wasm` | |:-------------------:|----------------------------------------------------------------------------------|:------------------:|:------------------:| | snarkvm |  | :white_check_mark: | :white_check_mark: | | snarkvm-algorithms |  | :white_check_mark: | :white_check_mark: | | snarkvm-circuit |  | :white_check_mark: | :white_check_mark: | | snarkvm-console |  | :white_check_mark: | :white_check_mark: | | snarkvm-curves |  | :white_check_mark: | :white_check_mark: | | snarkvm-fields |  | :white_check_mark: | :white_check_mark: | | snarkvm-ledger |  | :white_check_mark: | :white_check_mark: | | snarkvm-parameters |  | :white_check_mark: | :white_check_mark: | | snarkvm-synthesizer |  | :white_check_mark: | :white_check_mark: | | snarkvm-utilities |  | :white_check_mark: | :white_check_mark: | | snarkvm-wasm |  | :white_check_mark: | :white_check_mark: | For more information, visit [Welcome to Aleo](https://github.com/AleoNet/welcome) to get started. ## 2. Build Guide ### 2.1 Install Rust We recommend installing Rust using [rustup](https://www.rustup.rs/). You can install `rustup` as follows: - macOS or Linux: ```bash curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` - Windows (64-bit): Download the [Windows 64-bit executable](https://win.rustup.rs/x86_64) or [Windows 32-bit executable](https://win.rustup.rs/i686) and follow the on-screen instructions. ### 2.2.1 Build from Crates.io We recommend installing `snarkvm` this way. In your terminal, run: ```bash cargo install snarkvm ``` Now to use `snarkvm`, in your terminal, run: ```bash snarkvm ``` ### 2.2.2 Build from Source Code Alternatively, you can install `snarkvm` by building from the source code as follows: ```bash # Download the source code git clone --branch mainnet --single-branch https://github.com/AleoNet/snarkVM.git cd snarkVM git checkout tags/testnet-beta # Install snarkVM cargo install --path . ``` Now to use `snarkvm`, in your terminal, run: ```bash snarkvm ``` ## 3. Usage Guide ## 4. Contributors Thank you for helping make snarkVM better! [🧐 What do the emojis mean?](https://allcontributors.org/docs/en/emoji-key)

Howard Wu 💻 🚧 🤔 👀	Raymond Chu 💻 🚧 🤔 👀	d0cd 💻 🚧 🤔 👀	Pratyush Mishra 💻 🚧 🤔 👀	vicsn 💻 🚧 📖 👀	ljedrz 💻 🔧 👀	Mike Turner 💻 📖 👀
Collin Chin 💻 📖 👀	Alessandro Coglio 💻 📖 ⚠️	Niklas Long 💻	jules 💻	Ali Mousa 💻	Weikeng Chen 💻	Evan Schott 💻
Max Bruce 💻	zhiqiangxu 💻	Javier Rodríguez Chatruc 💻	Eduardo Morais 💻	Maciej Zwoliński 💻	Ivan Litteri 💻	Francisco Strambini 💻
Haruka 🐛 💻	StarLI-Trapdoor 💻	Vesa-Ville 💻	Jos Dehaes 💻	apruden2008 💻	Evan Marshall 🐛 💻	Psi Vesely 💻
swift-mx 💻	Nacho Avecilla 💻	qy3u 💻	Yt 💻	Kostyan 💻	stanlagermin 💻	Sukey 💻
Alex Zhao 💻	ghost ant 💻	Psi Vesely 💻	Dependabot 💻	Dependabot Preview 💻	All Contributors 📖
Add your contributions

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## 5. License [](./LICENSE.md)