Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install directly from git #49

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −11
Open

Install directly from git #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
616926f
doc: change install instructions
rot256 Jan 29, 2025
9856d55
doc: add both installation methods
rot256 Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# Stone CLI

A CLI for proving and verifying Cairo programs.
A convient CLI for proving and verifying Cairo programs.

## Installation

To install the CLI, use `cargo install`, either:

#### Directly from the repository:
```bash
cargo install --git https://github.com/zksecurity/stone-cli.git
```

#### From a local copy of the repository:
```bash
cargo install --path .
```

Currently, `linux/amd64` with `AVX` support and `macos/arm64` are supported.

## Overview

Expand All @@ -18,16 +34,6 @@ For the Ethereum verifier, there is an additional specific requirement: the proo

Please refer to the [Cairo book](https://book.cairo-lang.org/) for more details on how to create a Cairo program.

## Setup

Run the following command to install the CLI:

```bash
cargo install --path .
```

Currently, `linux/amd64` with `AVX` and `macos/arm64` are supported.

## Usage

### Prove
Expand Down