Skip to content

Commit

Permalink
readme: clarify poc-state and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
supakeen committed Apr 18, 2024
1 parent b8dedd9 commit e57456a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# Omnifest Toolkit

**THIS IS A PROOF OF CONCEPT REPOSITORY**

This is the "Omnifest Toolkit", also known as `otk`. A YAML transpiler to
take omnifest inputs and translate them into [osbuild](https://osbuild.org)
manifests.

We are still sketching out this potential approach to generating manifests and
thus this repository is very much a work in progress.

## Usage

```
€ python3 -m venv venv
€ . venv/bin/activate
€ pip install -e ".[dev]"
€ otk flatten example/fedora/minimal-40-x86_64.yaml
# ...
# See `otk --help` for help.
```

## Documentation

There is documentation about the [format](./doc/format.md) and the available
Expand Down

0 comments on commit e57456a

Please sign in to comment.