Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: updates again #29

Merged
merged 4 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .spellcheck-en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ osbuild
preprocessing
transpiler
Pre
pre
fedoraproject
Changelog
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

**THIS IS A PROOF OF CONCEPT REPOSITORY**

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

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

```
Expand All @@ -21,34 +21,35 @@ thus this repository is very much a work in progress.
# See `otk --help` for help.
```

## Pre Commit Checks
## Documentation

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

## Examples

Read the [examples](./example) to see what omnifests look like.

## Development

### Pre Commit Checks

To check your code for basic problems, we use https://pre-commit.com
To check our code for basic problems we use [pre-commit](https://pre-commit.com)
The tool itself will be installed by the `pip` command above (see [Usage](#Usage)) after that you
should run

```shell
pre-commit install
```

After that the system automatically checks upon commit, or you can run it against the whole
After this the system automatically checks upon commit, or you can run it against the whole
repository including all the tests with:

```
make test
```


## Documentation

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

## Examples

Read the [examples](./example) to see what omnifests look like.

## Tests
### Tests

To run the tests, you have to install the package (see [Usage](#Usage))
and call `pytest`
Expand All @@ -67,3 +68,11 @@ A list of current problems or things that just aren't that nice yet:
- Omnifests are valid YAML, no preprocessing is done on them.
- No introspection of the tree.
- No language-specific quirks in the directives (e.g. `eval`).

## Project

* **Website**: https://www.osbuild.org
* **Bug Tracker**: https://github.com/osbuild/otk/issues
* **Matrix**: #image-builder on [fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org)
* **Mailing List**: [email protected]
* **Changelog**: https://github.com/osbuild/otk/releases