docs: update README to reflect current state of repo
- also, there should only be one h1 per page
This commit is contained in:
parent
0b611a5238
commit
0fc7ac4331
1 changed files with 19 additions and 38 deletions
57
README.md
57
README.md
|
|
@ -2,58 +2,39 @@
|
|||
|
||||
[](https://github.com/ublue-os/bling/actions/workflows/build.yml)
|
||||
|
||||
A layer for extras and more bling for your image
|
||||
This repository containes modules to use in recipe.yml. See list of modules in [./modules](./modules/)
|
||||
|
||||
# Contains
|
||||
## Usage
|
||||
|
||||
- Default modules for [Startingpoint](https://github.com/ublue-os/startingpoint/)
|
||||
- A nix installer
|
||||
- Multiple fonts
|
||||
- Devpod
|
||||
- Justfiles
|
||||
- Yafti files
|
||||
- External repository files
|
||||
- Other `(TO BE DONE)`
|
||||
You can add this to your Containerfile to copy the modules from this image over:
|
||||
```dockerfile
|
||||
COPY --from=ghcr.io/ublue-os/bling:latest /modules /tmp/modules/
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
You can add this to your Containerfile to copy anything from this image over:
|
||||
|
||||
COPY --from=ghcr.io/ublue-os/bling:latest /files/usr/bin/ublue-nix-installer /
|
||||
COPY --from=ghcr.io/ublue-os/bling:latest /files/usr/bin/ublue-nix-uninstaller /
|
||||
|
||||
To use all fonts:
|
||||
|
||||
COPY --from=ghcr.io/ublue-os/bling:latest /files/usr/share/fonts /path/to/fonts
|
||||
|
||||
To use only Inter do:
|
||||
|
||||
COPY --from=ghcr.io/ublue-os/bling:latest /files/usr/share/fonts/inter /path/to/fonts/inter
|
||||
|
||||
We also want to package all these modifications as RPM packages for easier installation. `(TO BE DONE)`
|
||||
|
||||
# Verification
|
||||
## Verification
|
||||
|
||||
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:
|
||||
```sh
|
||||
cosign verify --key cosign.pub ghcr.io/ublue-os/bling
|
||||
```
|
||||
|
||||
cosign verify --key cosign.pub ghcr.io/ublue-os/bling
|
||||
## See what is in this image
|
||||
|
||||
# See what is in this image
|
||||
|
||||
## Raw commands
|
||||
### Raw commands
|
||||
|
||||
NOTE: This makes it so you need to extract everything from the base image!
|
||||
|
||||
```sh
|
||||
podman save ghcr.io/ublue-os/bling:latest -o bling.tar
|
||||
tar xf bling.tar && rm bling.tar
|
||||
tar xf *.tar
|
||||
podman save ghcr.io/ublue-os/bling:latest -o bling.tar
|
||||
tar xf bling.tar && rm bling.tar
|
||||
tar xf *.tar
|
||||
```
|
||||
|
||||
This should extract the image in a way that you can see everything in it!
|
||||
|
||||
## Using [Dive](https://github.com/wagoodman/dive)
|
||||
### Using [Dive](https://github.com/wagoodman/dive)
|
||||
|
||||
This method allows you to inspect the image through a TUI
|
||||
|
||||
dive ghcr.io/ublue-os/bling:latest
|
||||
```sh
|
||||
dive ghcr.io/ublue-os/bling:latest
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue