From ef3d43d94477c3cb1417fd03874ac8a02d284be4 Mon Sep 17 00:00:00 2001 From: antimoloch007 Date: Wed, 18 Dec 2024 11:14:45 -0800 Subject: [PATCH 1/2] Fix README.md install link Fixes README.md broken link: - Install now points to https://docs.succinct.xyz/docs/getting-started/install --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efa9cf59fc..f955674df0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ SP1 is the fastest, most-feature complete zero-knowledge virtual machine (zkVM) that can prove the execution of arbitrary Rust (or any LLVM-compiled language) programs. SP1 makes ZK accessible to *any developer*, by making it easy to write ZKP programs in normal Rust code. -**[Install](https://succinctlabs.github.io/sp1/getting-started/install.html)** +**[Install](https://docs.succinct.xyz/docs/getting-started/install)** | [Docs](https://succinctlabs.github.io/sp1) | [Examples](https://github.com/succinctlabs/sp1/tree/main/examples) | [Telegram Chat](https://t.me/+AzG4ws-kD24yMGYx) @@ -37,4 +37,4 @@ We would like to acknowledge the projects below whose previous work has been ins - [Plonky3](https://github.com/Plonky3/Plonky3): The SP1's prover is powered by the Plonky3 toolkit. - [Valida](https://github.com/valida-xyz/valida): The SP1 cross-table lookups, prover, borrow macro, and chip design, including constraints, are inspired by Valida. - [RISC0](https://github.com/risc0/risc0): The SP1 rust toolchain, install/build scripts, and our RISCV runtime borrow code from RISC0. -- [Cairo](https://docs.cairo-lang.org/how_cairo_works/builtins.html): Cairo introduced the idea of "builtins" which allow zkVMs to accelerate certain operations. However, the complexity of "builtins" was embedded in the CPU, limiting their complexity. SP1 extends this idea by executing on a vision of easily extensible "precompiles" that can be added as additional tables alongside the CPU. \ No newline at end of file +- [Cairo](https://docs.cairo-lang.org/how_cairo_works/builtins.html): Cairo introduced the idea of "builtins" which allow zkVMs to accelerate certain operations. However, the complexity of "builtins" was embedded in the CPU, limiting their complexity. SP1 extends this idea by executing on a vision of easily extensible "precompiles" that can be added as additional tables alongside the CPU. From 23ab932d1e20cd6dd73ad14edaf6baf0f24d84b4 Mon Sep 17 00:00:00 2001 From: antimoloch007 Date: Wed, 18 Dec 2024 11:18:38 -0800 Subject: [PATCH 2/2] Fix README.md Also update second Install and getting started links. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f955674df0..1b44aa522e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ SP1 is the fastest, most-feature complete zero-knowledge virtual machine (zkVM) Today, developers can write programs, including complex, large programs like a ZK Tendermint light client or type-1 zkEVM using Reth, in Rust (with std support), generate proofs and verify them. Most Rust crates should be supported and can be used seamlessly by your program. Example programs can be found in the [examples](https://github.com/succinctlabs/sp1/tree/main/examples) folder. -To get started, make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. Then follow the [installation](https://succinctlabs.github.io/sp1/getting-started/install.html) guide in the SP1 book and read the [getting started](https://succinctlabs.github.io/sp1/getting-started/quickstart.html) section. +To get started, make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. Then follow the [installation](https://docs.succinct.xyz/docs/getting-started/install) guide in the SP1 book and read the [getting started](https://docs.succinct.xyz/docs/getting-started/quickstart) section. ## Security