fix: add additional clarity to the location of files for the files mo…

…dule (#151) * fix: add additional clarity to the location of files for the files module * docs: chore: recommend files module instead of COPY --------- Co-authored-by: xyny <[email protected]>
blue-build · Sep 18, 2023 · 44fb925 · 44fb925
1 parent 7aee88c
commit 44fb925
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ After setup, it is recommended you update this README to describe your custom im
 
 The easiest way to start customizing is by looking at and modifying `config/recipe.yml`. It's documented using comments and should be pretty easy to understand.
 
-If you want to add custom configuration files, you can just add them in the `/usr/etc/` directory, which is the official OSTree "configuration template" directory and will be applied to `/etc/` on boot. `usr` is copied into your image by default. If you need to add other directories in the root of your image, that can be done in the Containerfile. Writing to `/var/` in the image builds of OSTree-based distros isn't supported and will not work, as that is a local user-managed directory!
+If you want to add custom configuration files, you can just add them in the `/usr/etc/` directory, which is the official OSTree "configuration template" directory and will be applied to `/etc/` on boot. `config/files/usr` is copied into your image's `/usr` by default. If you need to add other directories in the root of your image, that can be done using the `files` module. Writing to `/var/` in the image builds of OSTree-based distros isn't supported and will not work, as that is a local user-managed directory!
 
 For more information about customization, see [the README in the config directory](config/README.md)
 
@@ -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.
+See [the just-page in the Universal Blue documentation](https://universal-blue.org/guide/just/) for more information.
diff --git a/config/recipe.yml b/config/recipe.yml
@@ -13,10 +13,13 @@ modules:
 
   - type: files
     files:
-      - usr: /usr # copy static configurations
-                  # configuration you wish to end up in /etc/ on the booted system should be 
-                  # added into /usr/etc/ as that is the proper "distro" config directory on ostree
-                  # read more in the files module's README
+      - usr: /usr # copy static configurations 
+                  # 
+                  # copies config/files/usr into your image's /usr
+                  #
+                  # configuration you wish to end up in /etc/ on the booted system 
+                  # should be added into /usr/etc/ as that is the proper "distro" 
+                  # config directory on ostree read more in the files module's README
 
   - type: rpm-ostree
     repos: