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

docs: chore: include submodule documentation in the main bling README

Browse source 
There's a lot of bling "submodules" that might require documentation. Including them inside the same README is beneficial, because it makes the appear on the ublue website too, and their documentation is often not that long.
This commit is contained in:
xyny 2023-10-14 09:53:40 +00:00 • committed by GitHub
parent e9cdbc638b
commit 6fdfffcb69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
modules/bling/README.md
View file

@ -21,3 +21,20 @@ install:
# - laptop # installs TLP and configures your system for laptop usage
# - flatpaksync # allows synchronization of user-installed flatpaks. For more information, see the <bling-repo>/modules/bling/flatpaksync.md
```
## Submodule documentation
### `flatpaksync`
The `flatpaksync` submodule can be used to synchronize user-installed flatpaks into a gist or traditional repository.
Once the submodule is activated, users can create a file `$HOME/.config/flatpaksync/env` informing the repository that will be used to synchronize their apps in the POSIX standard:
```bash
GIST_REPO=<YOUR_REPO>
```
If the user has not yet installed their flatpaks, has already done the step above and has a `flatpak.list` file in the repository, simply use the `flatpakcheckout` binary to perform the installation and start the synchronization.
**It is important to note that this submodule will NOT enable Flathub. If your applications come from there, you will need to enable Flathub before running it.**
If the user has already configured their repository in the `$HOME/.config/flatpaksync/env` file but already has their flatpaks installed, simply create the `$HOME/.config/flatpaks.user.installed` file to start the synchronization.