Skip to content

Commit

Permalink
Add instructions to pull and build machine image from GHCR (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
guidanoli authored Aug 12, 2024
1 parent dd52633 commit 3340e70
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ make slides

## Building example bounties

Before testing, you need to compile bounties binaries.
Before building the machine image and testing, you need to compile the bounties binaries.

```sh
make bounties
Expand All @@ -66,12 +66,29 @@ Along with following exploits:

## Back-end

### Building the machine image
### Building the Cartesi Machine image

#### From source

```sh
cartesi build
```

#### From a tagged image

Every release, the machine image is built and published to GitHub Container Registry.
You can retrieve any given version using the `docker pull` command.

```sh
docker pull --platform linux/riscv64 ghcr.io/crypto-bug-hunters/bug-buster-machine:$VERSION
```

Then, you can build the Cartesi Machine image like so.

```sh
cartesi build --from-image ghcr.io/crypto-bug-hunters/bug-buster-machine:$VERSION
```

### Running the Cartesi Node

```
Expand Down

0 comments on commit 3340e70

Please sign in to comment.