diff --git a/README.md b/README.md index a2d6450a21..603a61c686 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Don't worry, it only requires some basic knowledge about using the terminal and After setup, it is recommended you update this README to describe your custom image. > **Note** -> Everywhere in this repository, make sure to replace `ublue-os/startingpoint` with the details of your own repository. Unless you used on of the automatic repository setup tools in which case the previous repo identifier should already be your repo's details. +> Everywhere in this repository, make sure to replace `ublue-os/startingpoint` with the details of your own repository. Unless you used one of the automatic repository setup tools 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". @@ -95,4 +95,4 @@ Then type `just` to list the just recipes available. The file `/usr/share/ublue-os/just/custom.just` is intended for the custom just commands (recipes) you wish to include in your image. By default, it includes the justfiles from [`ublue-os/bling`](https://github.com/ublue-os/bling), if you wish to disable that, you need to just remove the line that includes bling.just. -See [the just-page in the Universal Blue documentation](https://universal-blue.org/guide/just/) for more information. \ No newline at end of file +See [the just-page in the Universal Blue documentation](https://universal-blue.org/guide/just/) for more information.