Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[README] Unify spelling (use BE etc.) and #318

Merged
merged 1 commit into from
Aug 7, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Note that Patchmanager does not install an application icon on the launcher, but
To install Patchmanager you should use Storeman, which can be installed via the [Storeman-Installer](https://openrepos.net/content/osetr/storeman-installer), but you also may download the [recent Patchmanager RPM from OpenRepos](https://openrepos.net/content/patchmanager/patchmanager) and install it manually.
The modern alternative to using OpenRepos is the SailfishOS:Chum community repository, which can be easily accessed with the SailfishOS:Chum GUI application or with the ususal command line tools (`pkcon`, `zypper`), after downloading either the SailfishOS:Chum GUI application RPM or the SailfishOS:Chum repo helper RPM from [chumrpm.netlify.app](https://chumrpm.netlify.app/) and installing it. Both RPMs are also offered at OpenRepos (but the GUI app only for the recent SailfishOS release) and hence are installable by Storeman.

Modern patches for Patchmanager are provided via [the Web Catalog](https://coderus.openrepos.net/pm2/projects/), while older patches were provided as [RPMs at Openrepos](https://openrepos.net/category/patches) and some of them are still maintained.
Modern Patches for Patchmanager are provided via [the Web Catalog](https://coderus.openrepos.net/pm2/projects/), while older Patches were provided as [RPMs at OpenRepos](https://openrepos.net/category/patches) and some of them are still maintained.
Mind that many Patches were first released at OpenRepos but later migrated to the Web Catalog: For these you will find outdated RPMs, hence always search in the Web Catalog first.

If you want to translate ("localise") Patchmanager to a language you know well or enhance an existing translation, please use [Patchmanager's Transifex page](https://www.transifex.com/coderus/patchmanager3/).

## Information for Patch developers

To create a patch for Patchmanager, you must at least provide a patch file.
To create a Patch for Patchmanager, you must at least provide a patch file.
If you package your Patch as an RPM or archive file, you must also provide the JSON metadata: see below.
If you use the Web Catalog to distribute your Patch, you must not provide a JSON file, but input the corresponding data when submitting the patch file to the Web Catalog.

Expand All @@ -41,7 +41,7 @@ Either format is supported, but the modern one provides more useful features and

#### Additional files

Patchmanager starting from version 2.0 can utilize additional files to provide an enhanced user experience.
Patchmanager starting from version 2.0 can utilise additional files to provide an enhanced user experience.
All these files must be placed in the same folder.

- **main.qml** - A QML page with some additional information about a patch and / or its configuration. It will be shown when user taps on the patch entry inside Patchmanager.
Expand All @@ -52,19 +52,19 @@ All these files must be placed in the same folder.
## Patch distribution using Patchmanager's Web Catalog

Patchmanager supports installing Patches from its Web Catalog.
Patch developers can upload Patches to https://coderus.openrepos.net/pm2 to enlist them for the Web Catalog.
When uploading a Patch there, the Patch developer should not provide a `patch.json` file with metadata and must fill the necessary fields on the webpage before uploading: The Web Catalog will encode this metadata automatically and add it to the downloadable file.
Patch developers can upload Patches as archive files (`.zip`, `.tar.gz`, `.tar.bz2` or `.tar.xz`) at https://coderus.openrepos.net/pm2 to enlist them for the Web Catalog.
When uploading a Patch there, the Patch developer should not provide a `patch.json` file with metadata and must fill the necessary fields on the web-page before uploading: The Web Catalog will encode this metadata automatically and add it to the downloadable file.
Side note: If a JSON file is provided in the upload at the Web Catalog, it does not replace or mangle it; pay attention not to provide inconsistent data this way!

For more information about the requirements for using the Web Catalog, see https://coderus.openrepos.net/pm2/usage/
For more information about the requirements for uploading Patches to the Web Catalog, see https://coderus.openrepos.net/pm2/usage/

## Patch distribution at OpenRepos.net and other repositories

Patches can be too complex for Patchmanager's Web Catalog. In this case the developer may package the Patch as an RPM and upload it at https://openrepos.net or another user-accessible package repository.
OpenRepos provides a [category "Patches"](https://openrepos.net/category/patches) and a [tag "Patch"](https://openrepos.net/tags/patch) for this, which both should be used.

For RPM Patches, the Patch content should be installed in a directory `/usr/share/patchmanager/patches/<patch-name>/`; its [additional files](#additional-files) for this patch should also be placed there.
For RPM Patches, the patch file (`unified_diff.patch`) shall be installed in a directory `/usr/share/patchmanager/patches/<patch-name>/`; its [additional files](#additional-files) for this patch shall also be placed there.

Additionaly, when a Patch developer decides to package a Patch as an RPM, the compatibility of a Patch (to SailfishOS release versions, the software infrastructure it uses etc.) should be properly defined by RPM spec file dependencies ("Requires:", "Conflicts:" etc.).
Additionaly, if a Patch developer decides to package a Patch as an RPM, the compatibility of a Patch (to SailfishOS release versions, the software infrastructure it uses etc.) shall be properly defined by RPM spec file dependencies ("Requires:", "Conflicts:" etc.).

For an RPM Patch example, see https://github.com/CODeRUS/sailfishos-disable-glass-avatar