docs: detail & misc changes to flatpaksync docs

This commit is contained in:
xynydev 2023-10-22 12:52:58 +03:00
parent 96311d98d9
commit 7fb5eed708

View file

@ -25,16 +25,17 @@ install:
### `flatpaksync`
The `flatpaksync` submodule can be used to synchronize user-installed flatpaks into a gist or traditional repository.
The `flatpaksync` submodule can be used to synchronize a list of user Flatpaks with a git 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:
Once the submodule is activated, you should create the file `$HOME/.config/flatpaksync/env` that sets the `GIT_REPO` variable to the git URL of your repository. This repository can be empty, or a previous flatpaksync installation. The repository is automatically cloned into `/tmp/sync` for the synchronization.
```bash
# ~/.config/flatpaksync/env
GIT_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.
To initialize your Flatpaks from flatpaksync, simply run 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.
If you have configured the repository in the `$HOME/.config/flatpaksync/env` file but already have the Flatpaks installed, simply create the `$HOME/.config/flatpaks.user.installed` file to inform the script that the installation is done and start the synchronization.