Skip to content

Commit

Permalink
chore(book): build script + remove openssl (#316)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctian1 committed Mar 2, 2024
1 parent 197dbf0 commit 5e79f79
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
15 changes: 15 additions & 0 deletions book/generating-proofs/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,18 @@ To make this more concrete, let's walk through a simple example of generating a
```rust,noplayground
{{#include ../../examples/fibonacci-io/script/src/main.rs}}
```

## Build Script

If you want your program crate to be built automatically whenever you build/run your script crate, you can add a `build.rs` file inside of `script/`:

```rust,noplayground
{{#include ../../examples/fibonacci-io/script/build.rs}}
```

Make sure to also add `sp1-helper` as a build dependency in `script/Cargo.toml`:

```toml
[build-dependencies]
sp1-helper = { git = "https://github.com/succinctlabs/sp1.git" }
```
4 changes: 3 additions & 1 deletion book/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
SP1 currently runs on Linux and macOS. You can either use prebuilt binaries through sp1up or
build the toolchain and CLI from source.

Make sure you have [Rust](https://www.rust-lang.org/tools/install) and OpenSSL 1.1 (`brew install openssl@1.1` or use this [guide](https://askubuntu.com/questions/1102803/how-to-upgrade-openssl-1-1-0-to-1-1-1-in-ubuntu-18-04)) installed.
Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed.

## Option 1: Prebuilt Binaries (Recommended)

Currently our prebuilt binaries are built on Ubuntu 20.04 (22.04 on ARM) and macOS. If your OS uses an older GLIBC version, it's possible these may not work and you will need to [build the toolchain from source](#option-2-building-from-source).

sp1up is the SP1 toolchain installer. Open your terminal and run the following command and follow the instructions:

```bash
Expand Down

0 comments on commit 5e79f79

Please sign in to comment.