[flatpaks/flatpak-runtime] f45: README.md: fix markdownlint issues and update

[flatpaks/flatpak-runtime] f45: README.md: fix markdownlint issues and update

[Owen W. Taylor]

A new commit has been pushed.

Repo   : flatpaks/flatpak-runtime
Branch : f45
Commit : 150a4814488cf5f29063caa333fe543263ac7f11
Author : Owen W. Taylor <otaylor@fishsoup.net>
Date   : 2026-03-02T20:29:46-05:00
Stats  : +68/-69 in 1 file(s)
URL    : https://src.fedoraproject.org/flatpaks/flatpak-runtime/c/150a4814488cf5f29063caa333fe543263ac7f11?branch=f45

Log:
README.md: fix markdownlint issues and update

---
diff --git a/README.md b/README.md
index cf5ee85..48cb563 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-This git repository holds the modulemd file and associated container files
-for the Fedora Flatpak runtimes. It also holds scripts and data files used
-to maintain and update the Fedora Flatpak runtimes.
+# flatpaks/flatpak-runtime
 
-Updating
-========
+This git repository holds container definition file for the Fedora Flatpak runtimes.
+It also holds scripts and data files used to maintain and update the Fedora Flatpak runtimes.
+
+## Updating
 
 *Prequisites*: you need to have the following "upstream" runtimes installed:
 
@@ -22,27 +22,26 @@ And finally, you'll need to have
 of the corresponding Fedora runtimes. When you type `make update`, the
 steps are as follows:
 
- * List the contents of selected directories of the upstream runtime
-   (`tools/list-files.py`)
- * Exclude and rename files, and otherwise tweak the contents of the
-   resulting lists, and find the Fedora packages that contain the
-   corresponding packages. (`tools/resolve-files.py`)
- * Find all dependencies of the resolved packages using `flatpak-module-depchase resolve-deps`,
-   correlate it all together, figure out the install profiles for each runtime,
-   and create `report/runtime.html`. (`tools/generate-runtime-report.py`)
- * Create a `flatpak-runtime.new.yaml` using the profiles. (`tools/generate-modulemd.py`)
- * Finds data about applications packaged in Fedora and Flathub
-   (`tools/download-fedora-appstream.sh`, `tools/download-flathub-appstream.sh`,
-   `tools/download-reviews.py`)
- * Finds out how those applications would build using this runtime, and generates more reports
-   in `reports/`. (`tools/generate-app-reports.py`).
- * Copy `flatpak-runtime.new.yaml` to `flatpak-runtime.yaml`
+* List the contents of selected directories of the upstream runtime
+  (`tools/list-files.py`)
+* Exclude and rename files, and otherwise tweak the contents of the
+  resulting lists, and find the Fedora packages that contain the
+  corresponding packages. (`tools/resolve-files.py`)
+* Find all dependencies of the resolved packages using `flatpak-module-depchase resolve-requires`,
+  correlate it all together, figure out the install profiles for each runtime,
+  and create `report/runtime.html`. (`tools/generate-runtime-report.py`)
+* Create a `container.new.yaml` using the profiles. (`tools/generate-container-yaml.py`)
+* Finds data about applications packaged in Fedora and Flathub
+  (`tools/download-fedora-appstream.sh`, `tools/download-flathub-appstream.sh`,
+  `tools/download-reviews.py`)
+* Finds out how those applications would build using this runtime, and generates more reports
+  in `reports/`. (`tools/generate-app-reports.py`).
+* Copy `container.new.yaml` to `container.yaml`
 
 *Report generation*: if you type `make report` instead then all the above happens
 except the last step.
 
-Viewing the HTML reports
-========================
+## Viewing the HTML reports
 
 Because the application reports dynamically load generated JSON files, they can't
 be viewed as local files. You can run a web server to view them like:
@@ -56,66 +55,66 @@ podman run it --rm -p 8081:8080 \
 
 And then go to [https://localhost:8081/applications.html].
 
-Tweaking the result
-===================
+## Tweaking the result
+
 The main way to tweak the result is to edit and extend the data embedded in
 `tools/resolve-files.py`. Make sure you add comments explaining why you are
 excluding files, and feed back exclusions to the upstream runtime maintainers
 as appropriate.
 
-Package notes
-=============
+## Package notes
+
 To aid in keeping track of the status of all the packages in
 `report.html`, notes and "flags" are read from package-notes.txt. The
 notes are added to `report.html` and the flags affect formatting. The
 top of that file has a comment describing the simple format.
 
-Creating a runtime for a new Fedora release
-===========================================
+## Creating a runtime for a new Fedora release
+
 First make sure that the branches for new Fedora release are created in the
 following components:
 
- * [flatpaks/flatpak-runtime](https://src.fedoraproject.org/modules/flatpak-runtime/branches) - this repository
- * [flatpaks/flatpak-sdk](https://src.fedoraproject.org/modules/flatpak-sdk/branches)
- * [rpms/flatpak-runtime-config](https://src.fedoraproject.org/rpms/flatpak-runtime-config)
+* [flatpaks/flatpak-runtime](https://src.fedoraproject.org/modules/flatpak-runtime/branches) - this repository
+* [flatpaks/flatpak-sdk](https://src.fedoraproject.org/modules/flatpak-sdk/branches)
+ [rpms/flatpak-runtime-config](https://src.fedoraproject.org/rpms/flatpak-runtime-config)
 
 Once done, please do the following steps in this exact order:
 
- 1. Update `rpms/flatpak-runtime-config` package for a new Fedora release - i.e. [f35](https://src.fedoraproject.org/rpms/flatpak-runtime-config/c/c070b580e4ed7b200bcd26e6e055c2a2848c4962) and [f36](https://src.fedoraproject.org/rpms/flatpak-runtime-config/c/41b65b28446c382c193b4e2ff6d330e7b0f0b26b)
- 2. Create a new file under the data directory data/f36-live.packages (replace
-    the f36 with the new release) and put the list of packages
-    (`rpm -qa --qf "%{NAME}\n" | sort`) from a live Fedora Workstation media.
- 3. Replace all occurrences of an old Fedora release with the new one in `flatpaks/flatpak-runtime` - i.e. [f34 -> f35](https://src.fedoraproject.org/modules/flatpak-runtime/c/76972d6a76390f21e4e70fd960773e597d810de3) and [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-runtime/c/ff05f48642694c1aaf70df1fdc0a5a6d8fb30939)
- 4. Bump the required freedesktop and GNOME Flatpak SDKs versions if required in
-    `tools/generate-files.sh`
- 6. Run `make update`. In case of any problems you will need to update the
-    `tools/resolve-files.py` to adapt it for new library versions and so on.
-    Once the new runtime files are generated, consult the content of it and again
-    modify `tools/resolve-files.py` to exclude any libraries, binaries or packages
-    if needed.
- 7. Try to build the module and container locally with `flatpak-module local-build`
-    to verify that the changes from previous step are working.
- 8. Commit the change and do the official build with `fedpkg module-build -w`
-    followed by `fedpkg flatpak-build`
- 9. Update and build modules/flatpak-common - i.e. [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-common/c/17aeabbc448e3805a85e2c9313d40c608bc2611b?branch=f36)
-     and do an official build of with with `fedpkg module-build -w`. If you will
-     hit any build problems you might want to try to build the module locally
-     against the local packages with `flatpak-module build-module`. For that you
-     have to [setup your environment](https://docs.fedoraproject.org/en-US/flatpak/troubleshooting/#_rebuilding_a_module_against_a_local_component)
- 10. Update modules/flatpak-sdk - i.e. [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-sdk/c/83742941dc2b7e5c0cad78cb25c3ed9cc1b17d1a?branch=f36)
-     and build it with `fedpkg flatpak-build` (no need to build a module for
-     flatpak-sdk). On the other hand if you will need to make any changes to the
-     flatpak-runtime definitions (to add more packages that are not pulled on
-     x86_64 - i.e. [this change](https://src.fedoraproject.org/modules/flatpak-runtime/c/4737e749c62b19daf07366444517be9b98ff7ac9?branch=f36))
-     then you will need to again do a module build of flatpak-runtime and once
-     it's done, you can start a new `fedpkg flatpak-build` of flatpak-runtime
-     and flatpak-sdk.
- 11. Create a bodhi update for the new runtime and SDK - i.e. https://bodhi.fedoraproject.org/updates/FEDORA-FLATPAK-2022-16d56b1bde
- 12. Move all applications to the new runtime - i.e. [Evince Flatpak moving from f35 -> f36 ](https://src.fedoraproject.org/flatpaks/evince/c/7fccbf4bb8cea2d258226dfbe490327c59a44564?branch=stable)
-     and build it with `fedpkg module-build -w` and `fedpkg flatpak-build`. Also
-     it's a good time to update the `finish-args` from Flathub and update them
-     in Fedora if needed. Also update the module packages with the changes from the new Fedora release - i.e. `fedmod rpm2flatpak --flatpak-common --force --flathub=gimp gimp`.
-     You might find [the following howto useful](https://docs.fedoraproject.org/en-US/flatpak/tutorial/#_creating_application_yaml_and_container_yaml).
- 13. Create bodhi updates for moved applications
- 14. Switch to the new runtime for Anaconda - i.e. [f34 -> f35](https://pagure.io/pungi-fedora/c/d2e477b48368599834d6ec4adcc79f7115d98627?branch=main)
- 15. Once everything is moved, deprecate the old runtime and SDK - TBD
+1. Update `rpms/flatpak-runtime-config` package for a new Fedora release - i.e. [f35](https://src.fedoraproject.org/rpms/flatpak-runtime-config/c/c070b580e4ed7b200bcd26e6e055c2a2848c4962) and [f36](https://src.fedoraproject.org/rpms/flatpak-runtime-config/c/41b65b28446c382c193b4e2ff6d330e7b0f0b26b)
+1. Create a new file under the data directory data/f36-live.packages (replace
+   the f36 with the new release) and put the list of packages
+   (`rpm -qa --qf "%{NAME}\n" | sort`) from a live Fedora Workstation media.
+1. Replace all occurrences of an old Fedora release with the new one in `flatpaks/flatpak-runtime` - i.e. [f34 -> f35](https://src.fedoraproject.org/modules/flatpak-runtime/c/76972d6a76390f21e4e70fd960773e597d810de3) and [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-runtime/c/ff05f48642694c1aaf70df1fdc0a5a6d8fb30939)
+1. Bump the required freedesktop and GNOME Flatpak SDKs versions if required in
+   `tools/generate-files.sh`
+1. Run `make update`. In case of any problems you will need to update the
+   `tools/resolve-files.py` to adapt it for new library versions and so on.
+   Once the new runtime files are generated, consult the content of it and again
+   modify `tools/resolve-files.py` to exclude any libraries, binaries or packages
+   if needed.
+1. Try to build the container locally with `flatpak-module local-build`
+   to verify that the changes from previous step are working.
+1. Commit the change and do the official build with `fedpkg module-build -w`
+   followed by `fedpkg flatpak-build`
+1. Update and build modules/flatpak-common - i.e. [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-common/c/17aeabbc448e3805a85e2c9313d40c608bc2611b?branch=f36)
+    and do an official build of with with `fedpkg module-build -w`. If you will
+    hit any build problems you might want to try to build the module locally
+    against the local packages with `flatpak-module build-module`. For that you
+    have to [setup your environment](https://docs.fedoraproject.org/en-US/flatpak/troubleshooting/#_rebuilding_a_module_against_a_local_component)
+1. Update modules/flatpak-sdk - i.e. [f35 -> f36](https://src.fedoraproject.org/modules/flatpak-sdk/c/83742941dc2b7e5c0cad78cb25c3ed9cc1b17d1a?branch=f36)
+    and build it with `fedpkg flatpak-build` (no need to build a module for
+    flatpak-sdk). On the other hand if you will need to make any changes to the
+    flatpak-runtime definitions (to add more packages that are not pulled on
+    x86_64 - i.e. [this change](https://src.fedoraproject.org/modules/flatpak-runtime/c/4737e749c62b19daf07366444517be9b98ff7ac9?branch=f36))
+    then you will need to again do a module build of flatpak-runtime and once
+    it's done, you can start a new `fedpkg flatpak-build` of flatpak-runtime
+    and flatpak-sdk.
+1. Create a bodhi update for the new runtime and SDK - i.e. [https://bodhi.fedoraproject.org/updates/FEDORA-FLATPAK-2022-16d56b1bde
+1. Move all applications to the new runtime - i.e. [Evince Flatpak moving from f35 -> f36](https://src.fedoraproject.org/flatpaks/evince/c/7fccbf4bb8cea2d258226dfbe490327c59a44564?branch=stable)
+    and build it with `fedpkg module-build -w` and `fedpkg flatpak-build`. Also
+    it's a good time to update the `finish-args` from Flathub and update them
+    in Fedora if needed. Also update the module packages with the changes from the new Fedora release - i.e. `fedmod rpm2flatpak --flatpak-common --force --flathub=gimp gimp`.
+    You might find [the following howto useful](https://docs.fedoraproject.org/en-US/flatpak/tutorial/#_creating_application_yaml_and_container_yaml).
+1. Create bodhi updates for moved applications
+1. Switch to the new runtime for Anaconda - i.e. [f34 -> f35](https://pagure.io/pungi-fedora/c/d2e477b48368599834d6ec4adcc79f7115d98627?branch=main)
+1. Once everything is moved, deprecate the old runtime and SDK - TBD