diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 605863148..3be6452c9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -11,12 +11,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Use OCaml "4.14.0" - uses: avsm/setup-ocaml@v1 + uses: ocaml/setup-ocaml@v3 with: - ocaml-version: 4.14.0 + ocaml-compiler: "4.14.0" - name: Build Documentation run: | diff --git a/README.md b/README.md index 977a3e96e..ac55b6c23 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ and answering yes to the prompts. ## Design -The intention of this library is to allow writing snarks by writing what look +The intention of this library is to allow writing snarks by writing what looks like normal programs (whose executions the snarks verify). If you're an experienced functional programmer, the basic idea (simplifying somewhat) is that there is a monad `Checked.t` so that a value of type `'a Checked.t` is an `'a` whose computation is diff --git a/website/docs/readme.md b/website/docs/readme.md index 5150d20b5..ed0709450 100644 --- a/website/docs/readme.md +++ b/website/docs/readme.md @@ -16,7 +16,7 @@ be used in production systems. - Then, make sure you have [opam](https://opam.ocaml.org/doc/Install.html) installed. - Finally, install `snarky` and its dependencies by running ```bash -opam pin add git@github.com:o1-labs/snarky.git +opam pin add https://github.com/o1-labs/snarky.git ``` and answering yes to the prompts.