Table of Contents

• 1. Overview
• 2. Build Guide
• 3. Usage Guide
• 4. License

1. Overview

| Package | Crate.io | std | wasm | no_std | |:------------------:|-------------------------------------------------------------------------------|:------------------:|:------------------:|:--------------:| | snarkvm-algorithms || :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-curves | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-derives | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-dpc | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-fields | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-gadgets | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-marlin | | :whitecheckmark: | :construction: | :construction: | | snarkvm-objects | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-parameters || :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-polycommit || :whitecheckmark: | :construction: | :construction: | | snarkvm-posw | | :whitecheckmark: | :construction: | :construction: | | snarkvm-profiler | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-r1cs | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-utilities | | :whitecheckmark: | :whitecheckmark: | :construction: | | snarkvm-wasm | | :whitecheckmark: | :whitecheckmark: | :construction: |

For more information, visit Welcome to Aleo to get started.

2. Build Guide

2.1 Install Rust

We recommend installing Rust using rustup. 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 or Windows 32-bit executable and follow the on-screen instructions.

2.2a 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.2b Build from Source Code

Alternatively, you can install snarkvm by building from the source code as follows:

```bash

Download the source code

git clone https://github.com/AleoHQ/snarkvm && cd snarkvm

Install snarkVM

$ cargo install --path . ```

Now to use snarkvm, in your terminal, run: bash snarkvm

3. Usage Guide

4. License