diff --git a/contracts/README.md b/contracts/README.md index 709c1cdb..85c8677d 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -17,7 +17,7 @@ RISC0_USE_DOCKER=1 cargo build By setting the env variable `RISC0_USE_DOCKER` a containerized build process via `Docker` will ensure that all builds of your guest code, regardless of the machine or local environment, will produce the same [ImageID]. The ImageID, and its importance to [security], is explained in more detail in our [developer FAQ]. -> **Note**: *to install `Docker`, see [Get Docker].* +> ***Note:*** *This requires having Docker installed and in your PATH. To install Docker see [Get Docker](https://docs.docker.com/get-docker/).* Specifically: - `ImageID.sol`: contains the ImageIDs for the guests implemented in the [methods] directory. diff --git a/deployment-guide.md b/deployment-guide.md index 19abd887..d4a4fb2d 100644 --- a/deployment-guide.md +++ b/deployment-guide.md @@ -34,8 +34,8 @@ You can deploy your contracts and run an end-to-end test or demo as follows: export RISC0_USE_DOCKER=1 # enable a deterministic environment via Docker ``` - By setting *RISC0_USE_DOCKER=1* the build process will build your guest binary within a deterministic environment, resulting in a reproducible build. This is helpful because it allows third-parties to independently build the guest binary and generate the same [image ID]. For more details, see [reproducible build]. - > ***Note:*** *This requires having Docker installed. To install Docker see [Get Docker](https://docs.docker.com/get-docker/).* + By setting *RISC0_USE_DOCKER=1* the build process will build your guest binary within a deterministic environment, resulting in a reproducible build. This is helpful because it allows third-parties to independently build the guest binary and generate the same [image ID]. + > ***Note:*** *This requires having Docker installed and in your PATH. To install Docker see [Get Docker](https://docs.docker.com/get-docker/).* 3. Build your project: @@ -111,8 +111,8 @@ You can deploy your contracts on a testnet such as `Sepolia` and run an end-to-e export RISC0_USE_DOCKER=1 # enable a deterministic environment via Docker ``` - By setting *RISC0_USE_DOCKER=1* the build process will build your guest binary within a deterministic environment, resulting in a reproducible build. This is helpful because it allows third-parties to independently build the guest binary and generate the same [image ID]. For more details, see [reproducible build]. - > ***Note:*** *This requires having Docker installed. To install Docker see [Get Docker](https://docs.docker.com/get-docker/).* + By setting *RISC0_USE_DOCKER=1* the build process will build your guest binary within a deterministic environment, resulting in a reproducible build. This is helpful because it allows third-parties to independently build the guest binary and generate the same [image ID]. + > ***Note:*** *This requires having Docker installed and in your PATH. To install Docker see [Get Docker](https://docs.docker.com/get-docker/).* 2. Build your project: @@ -178,5 +178,4 @@ You can deploy your contracts on a testnet such as `Sepolia` and run an end-to-e [tested]: ./README.md#run-the-tests [Deploy your project to a local network]: #deploy-your-project-on-a-local-network [Deploy to a testnet]: #deploy-your-project-on-a-testnet -[image ID]: https://dev.risczero.com/terminology#image-id -[reproducible build]: TODO \ No newline at end of file +[image ID]: https://dev.risczero.com/terminology#image-id \ No newline at end of file