Skip to content

Latest commit

 

History

History
172 lines (143 loc) · 21 KB

README.md

File metadata and controls

172 lines (143 loc) · 21 KB

snarkVM

Table of Contents

1. Overview

Package Crate.io std wasm
snarkvm crates.io
snarkvm-algorithms crates.io
snarkvm-circuit crates.io
snarkvm-console crates.io
snarkvm-curves crates.io
snarkvm-fields crates.io
snarkvm-ledger crates.io
snarkvm-parameters crates.io
snarkvm-synthesizer crates.io
snarkvm-utilities crates.io
snarkvm-wasm crates.io

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:

2.2.1 Build from Crates.io

We recommend installing snarkvm this way. In your terminal, run:

cargo install snarkvm

Now to use snarkvm, in your terminal, run:

snarkvm

2.2.2 Build from Source Code

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

# 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:

snarkvm

3. Usage Guide

4. Contributors

Thank you for helping make snarkVM better!
🧐 What do the emojis mean?

Howard Wu
Howard Wu

💻 🚧 🤔 👀
Raymond Chu
Raymond Chu

💻 🚧 🤔 👀
d0cd
d0cd

💻 🚧 🤔 👀
Pratyush Mishra
Pratyush Mishra

💻 🚧 🤔 👀
vicsn
vicsn

💻 🚧 📖 👀
ljedrz
ljedrz

💻 🔧 👀
Mike Turner
Mike Turner

💻 📖 👀
Collin Chin
Collin Chin

💻 📖 👀
Alessandro Coglio
Alessandro Coglio

💻 📖 ⚠️
Niklas Long
Niklas Long

💻
jules
jules

💻
Ali Mousa
Ali Mousa

💻
Weikeng Chen
Weikeng Chen

💻
Evan Schott
Evan Schott

💻
Max Bruce
Max Bruce

💻
zhiqiangxu
zhiqiangxu

💻
Javier Rodríguez Chatruc
Javier Rodríguez Chatruc

💻
Eduardo Morais
Eduardo Morais

💻
Maciej Zwoliński
Maciej Zwoliński

💻
Ivan Litteri
Ivan Litteri

💻
Francisco Strambini
Francisco Strambini

💻
Haruka
Haruka

🐛 💻
StarLI-Trapdoor
StarLI-Trapdoor

💻
Vesa-Ville
Vesa-Ville

💻
Jos Dehaes
Jos Dehaes

💻
apruden2008
apruden2008

💻
Evan Marshall
Evan Marshall

🐛 💻
Psi Vesely
Psi Vesely

💻
swift-mx
swift-mx

💻
Nacho Avecilla
Nacho Avecilla

💻
qy3u
qy3u

💻
Yt
Yt

💻
Kostyan
Kostyan

💻
stanlagermin
stanlagermin

💻
Sukey
Sukey

💻
Alex Zhao
Alex Zhao

💻
ghost ant
ghost ant

💻
Psi Vesely
Psi Vesely

💻
Dependabot
Dependabot

💻
Dependabot Preview
Dependabot Preview

💻
All Contributors
All Contributors

📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

5. License

License: GPL v3