Skip to content

Commit

Permalink
fix: add usage instructions (ublue-os#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
castrojo authored Mar 4, 2023
1 parent 8bae1bc commit 3c1db1e
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@ A WIP common main image for all other Ublue images.

## What is this?

This is an upstream image for all of the other Ublue images to inherit from. This image contains common packages for different editions and is inteded for further customization by downstream images.

Graph of the [uBlue architecture](https://ublue.it/architecture/):

![](https://ublue.it/ublue-architecture-graph.png)
These images are Fedora images that have been modified with the following quality of life features:

## Features

Expand All @@ -21,9 +17,43 @@ Graph of the [uBlue architecture](https://ublue.it/architecture/):
- Sets flatpaks to update twice a day
- Everything else (desktop, artwork, etc) remains stock so you can use this as a good starting image

## Applications
## How to use these:

To rebase an existing Silverblue/Kinoite machine to the latest release (37):

Silverblue (GNOME):

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/silverblue-main:37

Kinoite (KDE)

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/kinoite-main:37

Sericea (Sway) (38-only, recommended only for advanced users)

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/sericea-main:38

Vauxite (XFCE)

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/vauxite-main:37

and finally Base, which does not come with any desktops or window managers, for builders:

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/base-main:37

## Architecture

This image can be used as an end user desktop or as something to derive from.
If you're interested in [making your own](https://ublue.it/making-your-own/):

Graph of the [uBlue architecture](https://ublue.it/architecture/):

![](https://ublue.it/ublue-architecture-graph.png)

### Adding Applications

Edit the `packages.json` file with your preferred applications
Edit the `packages.json` file with your preferred applications.
Flatpak installation is a WIP.

## Verification

Expand Down

0 comments on commit 3c1db1e

Please sign in to comment.