particle-os/particle-os-modules
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: misc readme changes

Browse source
This commit is contained in:
xyny 2024-06-30 10:20:40 +00:00 • committed by GitHub
parent 5552f66a9e
commit 26d02531e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
modules/justfiles/README.md
View file

@ -2,7 +2,7 @@
:::note The module is only compatible with Universal Blue images. :::
The `justfiles` module allows for easy `.just` files importing. It can be useful for example to separate DE specific justfiles when building multiple images.
The `justfiles` module makes it easy to include [just](https://just.systems/) recipes from multiple files in Universal Blue -based images. It can be useful for example when utilizing DE-specific justfiles when building multiple images. On the other hand, you likely wont need the module if you're building just one image or need just one justfile for all your images.
## What is just ?
@ -42,7 +42,7 @@ For more information, refer to these links:
Place all your `.just` files or folders with `.just` files inside the `config/justfiles/` folder. If that folder doesn't exist, create it.
Without specifying `include`, the module will assume you want to import everything. Otherwise, specify your files/folders under `include`.
By default, the module will import all files with names ending in `.just` from `config/justfiles/`. You can also specify files or subfolders under `include`, and they will be the only ones imported.
If you also want to validate your justfiles, set `validate: true`. The validation can be very unforgiving and is turned off by default.