diff --git a/README.md b/README.md index e9e5ff5..aee0951 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Starting point -[![build-ublue](https://github.com/ublue-os/startingpoint/actions/workflows/build.yml/badge.svg)](https://github.com/ublue-os/startingpoint/actions/workflows/build.yml) +[![build-ublue](https://github.com/gmpinder/wunker-os/actions/workflows/build.yml/badge.svg)](https://github.com/gmpinder/wunker-os/actions/workflows/build.yml) This is a constantly updating template repository for creating [a native container image](https://fedoraproject.org/wiki/Changes/OstreeNativeContainerStable) designed to be customized however you want. GitHub will build your image for you, and then host it for you on [ghcr.io](https://github.com/features/packages). You then just tell your computer to boot off of that image. GitHub keeps 90 days worth image backups for you, thanks Microsoft! @@ -13,7 +13,7 @@ See the [Make Your Own -page in the documentation](https://ublue.it/making-your- Don't worry, it only requires some basic knowledge about using the terminal and git. > **Note** -> Everywhere in this repository, make sure to replace `ublue-os/startingpoint` with the details of your own repository. Unless you used [`create-ublue-image`](https://github.com/EinoHR/create-ublue-image), in which case the previous repo identifier should already be your repo's details. +> Everywhere in this repository, make sure to replace `gmpinder/wunker-os` with the details of your own repository. Unless you used [`create-ublue-image`](https://github.com/EinoHR/create-ublue-image), in which case the previous repo identifier should already be your repo's details. > **Warning** > To start, you *must* create a branch called `live` which is exclusively for your customizations. That is the **only** branch the GitHub workflow will deploy to your container registry. Don't make any changes to the original "template" branch. It should remain untouched. By using this branch structure, you ensure a clear separation between your own "published image" branch, your development branches, and the original upstream "template" branch. Periodically sync and fast-forward the upstream "template" branch to the most recent revision. Then, simply rebase your `live` branch onto the updated template to effortlessly incorporate the latest improvements into your own repository, without the need for any messy, manual "merge commits". @@ -35,7 +35,7 @@ If you want to execute custom shell scripts or commands in the image build, you Instead, you should create your own custom shell scripts in the `scripts/` directory (look at the `example.sh`). After creating your scripts, enable them in the `scripts:` section of your `recipe.yml`, within the specific "build stage" category where the scripts are intended to be executed. Alternatively, enable the `autorun.sh` helper script in your recipe to automatically execute your custom scripts. -Read [the README in the `scripts/` directory](https://github.com/ublue-os/startingpoint/blob/main/scripts/README.md) for more information. +Read [the README in the `scripts/` directory](https://github.com/gmpinder/wunker-os/blob/main/scripts/README.md) for more information. ### Custom package repositories @@ -87,13 +87,13 @@ If you want to completely disable yafti, simply set the recipe's `firstboot.yaft To rebase an existing Silverblue/Kinoite installation to the latest build: ``` -sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/startingpoint:latest +sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/gmpinder/wunker-os:latest ``` This repository builds date tags as well, so if you want to rebase to a particular day's build: ``` -sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/startingpoint:20230403 +sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/gmpinder/wunker-os:20230403 ``` The `latest` tag will automatically point to the latest build. That build will still always use the Fedora version specified in `recipe.yml`, so you won't get accidentally updated to the next major version. @@ -133,6 +133,6 @@ Check the [just website](https://just.systems) for tips on modifying and adding These images are signed with sisgstore's [cosign](https://docs.sigstore.dev/cosign/overview/). You can verify the signature by downloading the `cosign.pub` key from this repo and running the following command: - cosign verify --key cosign.pub ghcr.io/ublue-os/startingpoint + cosign verify --key cosign.pub ghcr.io/gmpinder/wunker-os If you're forking this repo, the uBlue website has [instructions](https://ublue.it/making-your-own/) for setting up signing properly.