particle-os-modules/modules/yafti/README.md
xyny 4e79916835
docs: enhacements to module documentation (#54)
* docs: chore: rn ":" from "Example configuration"

* docs: correct title casing for fonts module title

* docs: document OS_VERSION in example,...
non-copr example for rpmrepos

* docs: remove bling fonts option from bling example

* docs: start yafti README the same way as others
"The yafti module..."
2023-10-01 08:41:01 -07:00

16 lines
732 B
Markdown

# [`yafti`](https://github.com/ublue-os/yafti) Module for Startingpoint
The `yafti` module can be used to install `yafti` and set it up to run on first boot. Also `yafti`'s dependencies, `python3-pip` and `libadwaita` are installed.
Optionally, a list of Flatpak names and IDs can be included under `custom-flatpaks:`. These will be enabled by default under their own section on the Flatpak installation screen of `yafti`.
The main `yafti` configuration file, `yafti.yml`, is in `/usr/share/ublue-os/firstboot/yafti.yml` and can be edited for a more custom first-boot experience.
## Example configuration
```yaml
type: yafti
custom-flatpaks:
- Celluloid: io.github.celluloid_player.Celluloid
- Krita: org.kde.krita
```