From 283145fe2a8f86de470f5e88ae3fb47fdcdb2be4 Mon Sep 17 00:00:00 2001
From: Florian Wilhelm <2292245+fwilhe@users.noreply.github.com>
Date: Wed, 11 Oct 2023 14:14:52 +0000
Subject: [PATCH] Improve readme

---
 README.md | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 84c48d4..655cc44 100644
--- a/README.md
+++ b/README.md
@@ -6,10 +6,22 @@ This is a experimental repo to build Debian OSTree images.
 
 This repo is built using the [Garden Linux Builder](https://github.com/gardenlinux/builder#builder), which uses podman, see it's readme for setup instructions.
 
+This repo has two ostree related features (build targets).
+You can run them with the following commands:
+
 ```bash
-$ ./build ostree
+$ ./build ostreeRepo
+$ ./build ostreeImage
 ```
 
+For just getting a bootable system, use `ostreeImage`.
+This will produce a raw disk image that can be booted in qemu.
+See below for the command to boot the image.
+
+`ostreeRepo` will give you an OSTree repo in the form of a tarball.
+The output will have a name like `.build/ostreeRepo-*-trixie-*.ostreeRepo.tar.gz`
+This is the foundation for building the disk image, but it is also usable as a remote repo for upgrading the system.
+
 ## Run
 
 Use the `bin/start-vm` script from [Garden Linux](https://github.com/gardenlinux/gardenlinux/blob/main/bin/start-vm).
@@ -17,11 +29,15 @@ Use the `bin/start-vm` script from [Garden Linux](https://github.com/gardenlinux
 Depending on your architecture, it should look like this:
 
 ```bash
-$ path/to/gardenlinux/bin/start-vm --no-watchdog .build/ostree-arm64-trixie*.ostree.raw
+$ path/to/gardenlinux/bin/start-vm --no-watchdog .build/ostreeImage-arm64-trixie*.ostree.raw
 ```
 
 ```bash
-$ path/to/gardenlinux/bin/start-vm --no-watchdog .build/ostree-amd64-trixie*.ostree.raw
+$ path/to/gardenlinux/bin/start-vm --no-watchdog .build/ostreeImage-amd64-trixie*.ostree.raw
 ```
 
 Check for the actual name of the image in the `.build` directory.
+
+Inside the booted vm, you can run the `ostree-upgrade` script to upgrade your OS to the latest version.
+
+Refer to the [OSTree command man page](https://ostreedev.github.io/ostree/man/ostree.html) for instructions of using the cli.