Skip to content

Commit

Permalink
docs: improve modules section in config readme (#209) (#217)
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev authored and michaelhaaf committed Jan 28, 2024
1 parent 9ea1022 commit 8264b47
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This repository fetches some useful default modules from [`ublue-os/bling`](http

For a comprehensive list of modules, their in-depth documentation and example configuration, check out [the Modules page on the website](https://universal-blue.org/tinker/modules/).

### Building multiple images and including module configuration from other files and
### Building multiple images and including module configuration from other files

To build multiple images, you need to create another recipe.yml file, which you should name based on what kind of image you want it to build. Then, edit the [`build.yml`](../.github/workflows/build.yml) file. Inside the file, under `jobs: strategy: matrix:`, there's a list of recipe files to build images, which you need to add your new recipe file to. These should be paths to files inside the `config` directory.

Expand All @@ -39,4 +39,18 @@ install:
- dunst
- rofi
- kitty
```
```
An external module can also include multiple modules.
```yaml
# config/common.yml
modules:
- type: files
files:
- usr: /usr
- type: rpm-ostree
install:
- i3
- dunst
- rofi
- kitty
```

0 comments on commit 8264b47

Please sign in to comment.