snarkOS

snarkOS is a decentralized operating system for confidential programs.

Table of Contents

• 1. Overview
• 2. Build Guide
  • 2.1 Install Rust
  • 2.2a Build from Crates.io
  • 2.2b Build from Source Code
• 3. Usage Guide
• 4. License

1. Overview

[WIP]

2. Build Guide

2.1 Install Rust

We recommend installing Rust using rustup. You can install rustup as follows:

• macOS or Linux:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Windows (64-bit):

  Download the Windows 64-bit executable and follow the on-screen instructions.

• Windows (32-bit):

  Download the Windows 32-bit executable and follow the on-screen instructions.

2.2a Build from Crates.io

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

cargo install snarkos

Now to use snarkOS, in your terminal, run:

snarkos

2.2b Build from Source Code

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

# Download the source code
git clone https://github.com/AleoHQ/snarkOS
cd snarkOS

# Build in release mode
$ cargo build --release

This will generate an executable under the ./target/release directory. To run snarkOS, run the following command:

./target/release/snarkos

2.3b Run by Docker

Docker build

docker build -t snarkos:latest . (or docker-compose build)

Docker run

docker run -d -p 4130:4130 --name snarkos snarkos (or docker-compose up)

3. Usage Guide

[WIP]

4. License

LICENSE