Skip to content

Commit

Permalink
chore: tidy readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
nixpig committed Oct 25, 2024
1 parent 8cb4384 commit 16a122a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@

# 🍪 brownie

An experimental Linux container runtime, attempting to implement the OCI Runtime Spec. See below for progress against that goal.
An experimental Linux container runtime, attempting to implement the OCI Runtime Spec. See the [Progress](#progress) section below for progress against that goal.

> [!NOTE]
>
> 📅 **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).
>
> See the [Progress](#progress) section below for progress against the remaining test suites.
This is a personal project for me to explore and better understand the [OCI Runtime Spec](https://github.com/opencontainers/runtime-spec/blob/main/spec.md) to support other projects I'm working on. It's not production-ready, and it probably never will be, but feel free to look around! If you're looking for a production-ready alternative to `runc`, take a look at [`youki`](https://github.com/containers/youki); it does things a bit differently and is pretty cool.

Expand Down Expand Up @@ -148,7 +146,7 @@ Flags:

## Progress

My goal is for `brownie` to (eventually) pass all test suites in the [opencontainers OCI Runtime Spec tests](https://github.com/opencontainers/runtime-tools?tab=readme-ov-file#testing-oci-runtimes). Below is progress against that goal.
My goal is for `brownie` to (eventually) pass all tests in the [opencontainers OCI Runtime Spec tests](https://github.com/opencontainers/runtime-tools?tab=readme-ov-file#testing-oci-runtimes). Below is progress against that goal.

### ✅ Passing

Expand Down
1 change: 1 addition & 0 deletions internal/commands/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ func Delete(opts *DeleteOpts, log *zerolog.Logger, db *sql.DB) error {

log.Info().Msg("execing poststop hooks")
if err := cntr.ExecHooks("poststop"); err != nil {
fmt.Println("failed to execute poststop hooks")
log.Warn().Err(err).Msg("failed to execute poststop hooks")
}

Expand Down
1 change: 1 addition & 0 deletions internal/commands/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ func Start(opts *StartOpts, log *zerolog.Logger, db *sql.DB) error {

log.Info().Msg("execing poststop hooks")
if err := cntr.ExecHooks("poststop"); err != nil {
fmt.Println("WARNING: failed to execute poststop hooks")
log.Warn().Err(err).Msg("failed to execute poststop hooks")
}

Expand Down

0 comments on commit 16a122a

Please sign in to comment.