Skip to content
This repository has been archived by the owner on Aug 6, 2024. It is now read-only.

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fwilhe committed Oct 18, 2023
1 parent 06d853d commit 1cc541a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,35 @@ Builder for [OSTree](https://ostreedev.github.io/ostree/)-based operating system

See [this blog post series for background information on the PoC and its motivation](https://blogs.sap.com/2023/07/10/making-an-immutable-image-based-operating-system-out-of-garden-linux/).

Refer to [the Garden Linux README for setup instructions for the Builder](https://github.com/gardenlinux/gardenlinux#build).

This repo contains two os builder definitions.

The `debian` directory contains a build for a debian trixie image.
It takes packages from the Debian apt repositories.

To build it yourself, run inside the `debian` directory:

```bash
# Optional: To build the OSTree Repo
$ ./build ostreeRepo
# To build the bootable image
$ ./build ostreeImage
```

> [!NOTE]
> The `ostreeImage` will download a copy of the OSTree repository from the Garden Linux artifact storage.
You don't need to run `ostreeRepo` locally.

The `gardenlinux` directory contains a build for a gardenlinux today image.
It takes packages from the Garden Linux apt repositories.
This directory contains a lot of code taken from the [gardenlinux/gardenlinux](https://github.com/gardenlinux/gardenlinux) repo.

To build it yourself, run inside the `gardenlinux` directory:

```bash
# Optional: To build the OSTree Repo
$ ./build kvm_dev_curl-ostreeRepo
# To build the bootable image
$ ./build ostreeImage
```

0 comments on commit 1cc541a

Please sign in to comment.