-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,26 +4,34 @@ | |
|
|
||
| An experimental Linux container runtime. | ||
|
|
||
| Currently passing the [default test suite](https://github.com/opencontainers/runtime-tools?tab=readme-ov-file#testing-oci-runtimes) for [OCI Runtime Spec](https://github.com/opencontainers/runtime-spec/blob/v1.2.0/spec.md) compliance. | ||
| > [!NOTE] | ||
| > As of October 1st, 2024, `brownie` passes all 270 _default_ tests in the [opencontainers OCI runtime test suite](https://github.com/opencontainers/runtime-tools?tab=readme-ov-file#testing-oci-runtimes). | ||
| > [!CAUTION] | ||
| > This is an experimental project. It will make changes to your system. Take appropriate precautions. | ||
| This is currently a personal project, so I'm not interested in taking code contributions. However, if you have any comments/suggestions/feedback, do feel free to leave them in [issues](https://github.com/nixpig/brownie/issues). | ||
| This is currently a personal project. As such, I'm not interested in taking code contributions. However, if you have any comments/suggestions/feedback, do feel free to leave them in [issues](https://github.com/nixpig/brownie/issues). | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Build from source | ||
| `brownie` has been tested on: | ||
|
|
||
| Brownie is written in Go. You'll need the Go compiler installed to build from source. | ||
| - `go version go1.23.0 linux/amd64` | ||
| - `Linux 6.10.2-arch1-1 x86_64 GNU/Linux` | ||
|
|
||
| Assuming you have a Go compiler installed... | ||
| > [!CAUTION] | ||
| > This is an experimental project. It will make changes to your system. Take appropriate precautions. | ||
| ### Build from source | ||
|
|
||
| **Prerequisite:** Compiler for Go installed ([instructions](https://go.dev/doc/install)). | ||
|
|
||
| 1. `git clone [email protected]:nixpig/brownie.git` | ||
| 1. `cd brownie` | ||
| 1. `make build` | ||
| 1. `mv tmp/bin/brownie ~/.local/bin` | ||
|
|
||
| ## Usage | ||
|
|
||
| The `brownie` CLI implements the [OCI Runtime Command Line Interface](https://github.com/opencontainers/runtime-tools/blob/master/docs/command-line-interface.md) spec. | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](https://github.com/nixpig/brownie?tab=MIT-1-ov-file#readme) | ||