Skip to content

Commit

Permalink
Fix README links (risc0#490)
Browse files Browse the repository at this point in the history
* Fix README links

* Update README.md

Co-authored-by: Tim Zerrell <[email protected]>

---------

Co-authored-by: Tim Zerrell <[email protected]>
  • Loading branch information
flaub and tzerrell authored Apr 1, 2023
1 parent d8f18bd commit 5b65ad6
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,33 +95,26 @@ other manner of problems. Caveat emptor.

## Getting Started

First, clone this repository and [install rust](install-rust).

To start your own project, you can use our `cargo risczero` tool to write the
initial boilerplate and set up a standard file structure. First install the tool
initial boilerplate and set up a standard directory structure.
First, [install Rust][install-rust] if you don't already have it, then install the `cargo risczero` tool:

```
cargo install cargo-risczero
```
Then, create a new project (named `my_project` in this example command)

Then, create a new project (named `my_project` in this example):

```
cargo risczero new my_project
```
More details and options for `cargo risczero` are given in
[its README](cargo-risczero-readme).

To run a simple RISC Zero program, navigate to the `examples/factors` directory
and run `cargo run`:
```
cd examples/factors
cargo run -r
```
This should produce the output `I know the factors of 391, and I can prove it!`.
Congratulations, you've produced your first RISC Zero zero-knowledge proof! You
can find more examples in this [examples folder](examples).
More details and options for `cargo risczero` are given in
[its README][cargo-risczero-readme].

For more guidance on how to use RISC Zero, how RISC Zero projects are typically
structured, and other resources useful to developers new to RISC Zero, see our
[Getting Started page](website-getting-started).
[Getting Started page][website-getting-started].

## Rust Binaries

Expand Down Expand Up @@ -154,6 +147,7 @@ Included is a tool to manage RISC Zero project directories.
```bash
# Installing from local source
cargo install --path risc0/cargo-risczero

# Install from crates.io
cargo install cargo-risczero
```
Expand Down

0 comments on commit 5b65ad6

Please sign in to comment.