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

docs: Update "Usage" with more accurate steps on how to get the recipe input

Browse source
This commit is contained in:
fiftydinar 2024-04-09 19:44:30 +02:00
parent 10f53b27e6
commit 5e393fee44
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
modules/gnome-extensions/README.md
View file

@ -19,9 +19,12 @@ What does this module do?
# Usage
To use this module, you need to input gettext-domain of the extension without @ symbol + the version of the extension in `.v%VERSION%` format.
You can see gettext-domain of the extension by looking at the extension repo inside metadata.json
or by simply downloading the zip file from https://extensions.gnome.org & than looking at the download URL part after `/extension-data/` & before `.v%VERSION%`.
To use this module, you need to input gettext-domain of the extension without @ symbol + the version of the extension in `.v%VERSION%` format in module recipe.
But for some extensions, `.v%VERSION%` is parsed as the version of package in incremental numbering, instead of extension version in https://extensions.gnome.org URL.
So to be sure that you got the correct module input, follow the steps below.
You must assure that version of the extension is compatible with current Gnome version that your image is using.
You can easily see this information when downloading extension from https://extensions.gnome.org
How to gather correct module input:
1. Go to https://extensions.gnome.org
2. Search for the extension that you want
3. Select the matching Gnome shell version & extension version that you want to download
4. When extension is downloaded, you get the info when you omit `.shell-extension.zip` suffix from the extension zip file-name