Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nixpig committed Dec 27, 2024
1 parent e67c2d1 commit c865ec1
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,10 @@ This is a personal project for me to explore and better understand the OCI Runti
>
> Given this is an experimental project, take appropriate precautions.
I'm developing `brownie` on the following environment. Even with the same set up, YMMV.
You can spin up this VM from the included `Vagrantfile`, just run `vagrant up`.

- `Linux vagrant 6.8.0-31-generic #31-Ubuntu SMP PREEMPT_DYNAMIC Sat Apr 20 00:40:06 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux`
- `go version go1.23.4 linux/amd64`
- `Docker version 27.3.1, build ce12230`

### Download pre-built binary

1. Go to [Releases](https://github.com/nixpig/brownie/releases/) and download the tarball for your architecture.
1. Extract the `brownie` binary from the tarball and put somewhere in `$PATH`.
1. Go to [Releases](https://github.com/nixpig/brownie/releases/) and download the tarball for your architecture, e.g. `brownie_0.0.1_linux_amd64.tar.gz`.
1. Extract the `brownie` binary from the tarball and put somewhere in `$PATH`, e.g. `~/.local/bin`.


### Build from source
Expand All @@ -52,6 +45,16 @@ make build
mv tmp/bin/brownie ~/.local/bin
```

---

I'm developing `brownie` on the following environment. Even with the same set up, YMMV.
You can spin up this VM from the included `Vagrantfile`, just run `vagrant up`.

- `Linux vagrant 6.8.0-31-generic #31-Ubuntu SMP PREEMPT_DYNAMIC Sat Apr 20 00:40:06 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux`
- `go version go1.23.4 linux/amd64`
- `Docker version 27.3.1, build ce12230`


## Usage

> [!NOTE]
Expand Down

0 comments on commit c865ec1

Please sign in to comment.