Skip to content

Commit

Permalink
simplify and accuratise most of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noahdotpy committed Jan 8, 2024
1 parent b2373da commit 7590b20
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,11 @@
[![build-ublue](https://github.com/noahdotpy/.mykinoite/actions/workflows/build.yml/badge.svg)](https://github.com/noahdotpy/.mykinoite/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!
This is a constantly updating repository which hosts my custom [ostree images](https://fedoraproject.org/wiki/Changes/OstreeNativeContainerStable) designed to be customized however you want. GitHub will build this image, and then host it on [ghcr.io](https://github.com/features/packages). The users can then tell the computer to boot off of that image. GitHub keeps 90 days worth of image backups for us, thanks Microsoft!

For more info, check out the [uBlue homepage](https://universal-blue.org/) and the [main uBlue repo](https://github.com/ublue-os/main/)
For info on how to create your own, check out [ublue/startingpoint](https://github.com/ublue-os/startingpoint) and the [ublue tinkering documentation](https://universal-blue.org/tinker/make-your-own/).

## Getting started

See the [Make Your Own-page in the documentation](https://universal-blue.org/tinker/make-your-own/) for quick setup instructions for setting up your own repository based on this template.

Don't worry, it only requires some basic knowledge about using the terminal and git.

After setup, it is recommended you update this README to describe your custom image.

> **Note**
> Everywhere in this repository, make sure to replace `noahdotpy/.mykinoite` 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".
> TODO: I should probably customize the below README sections for my repo
## Customization

Expand Down

0 comments on commit 7590b20

Please sign in to comment.