Skip to content

Commit 8785d64

Browse files
committed
Update readme with inclusion criteria, process and other info
1 parent 6cc5a6f commit 8785d64

File tree

1 file changed

+37
-22
lines changed

1 file changed

+37
-22
lines changed

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,78 @@
1-
This repository contains commonly shared modules and is intended to be used as a git submodule.
1+
## Flathub shared modules
22

3-
Each submodule may include additional instructions to be used properly. Please check the folder containing that module to see if anything extra needs to be done.
3+
This repository contains Flatpak build recipes of commonly shared
4+
modules and is intended to be used as a git submodule. Each submodule
5+
may include additional instructions to be used properly. Please check
6+
the folder containing that module to see if anything extra needs to be
7+
done.
48

5-
## Adding
9+
### Adding
610

711
To use shared modules for packaging an application, add the submodule:
812

9-
```
13+
```sh
1014
git submodule add https://github.com/flathub/shared-modules.git
1115
```
1216

13-
## Usage
17+
### Usage
1418

1519
Then modules from this repository can be specified in an application
1620
manifest.
1721

1822
```json
1923
"modules": [
2024
"shared-modules/SDL/SDL-1.2.15.json",
21-
{
22-
"name": "foo"
23-
}
2425
]
2526
```
2627
And for a YAML manifest:
27-
```YAML
28+
29+
```yaml
2830
modules:
2931
- shared-modules/SDL/SDL-1.2.15.json
30-
31-
- name: foo
3232
```
3333
34-
## Updating
34+
### Updating
3535
3636
To update the submodule:
3737
38-
```
38+
```sh
3939
git submodule update --remote --merge
4040
```
4141

42-
## Removing
42+
To automate updates, [dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
43+
can be used but please limit the update frequency to not more than once
44+
or twice a week.
45+
46+
### Removing
4347

4448
To remove the submodule:
4549

46-
```
50+
```sh
4751
git submodule deinit -f -- shared-modules
4852
rm -rf .git/modules/shared-modules
4953
git rm -f shared-modules
5054
rm .gitmodules
5155
```
5256

53-
We provide an automatic updating mechanism for submodules located here. In order to utilize it:
57+
### External data checker
58+
59+
We provide an automatic updating mechanism for submodules located here.
60+
In order to utilize it [set up x-checker-data](https://github.com/flathub/flatpak-external-data-checker)
61+
for your sources and they will be checked for updates in a weekly basis.
62+
63+
### Inclusion criteria
64+
65+
- The module must be widely used on [Flathub](https://github.com/flathub)
66+
by actively maintained applications.
67+
68+
- The module must not be provided by any current branch of the runtimes.
5469

55-
- Set up x-checker-data for your sources: https://github.com/flathub/flatpak-external-data-checker#url-checker
70+
- The module manifest must be in JSON format.
5671

57-
And it will check for updates in a weekly basis.
72+
### Inclusion process
5873

59-
Please do not request adding modules unless they are widely used in
60-
the Flathub repository.
74+
Please open a [pull request](https://github.com/flathub/shared-modules/pulls)
75+
with the module manifest and add yourself as a [codeowner](https://github.com/flathub/shared-modules/blob/master/CODEOWNERS)
76+
of that module.
6177

62-
All shared modules manifests in this repository are, and need to be, in the JSON format,
63-
which is supported by both Flatpak manifest formats, JSON and YAML.
78+
The manifest must be buildable with the latest Freedesktop SDK runtime.

0 commit comments

Comments
 (0)