From 7b7be5439a07d56c3a71b75aaa70660654779ad2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Fri, 13 Sep 2024 13:25:19 +0200 Subject: [PATCH] Update README after repo split --- README.md | 45 ++++++++++++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4152e7f511..236819c279 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,8 @@ YunoHost logoPackage logo -This repository contains the default YunoHost app catalog, as well as related -tools that can be run manually or automatically. - -The catalog is stored in [**`apps.toml`**](./apps.toml) and is browsable here: - - -It contains references to the apps' repositories, along with a few metadata about -them such as their category or maintenance state. This file is regularly read by -`tools/list_builder.py` which publish the results on . +This repository contains the default YunoHost app catalog. +It is browsable at [apps.yunohost.org](https://apps.yunohost.org). ## Where can I learn about app packaging in YunoHost? @@ -18,6 +11,36 @@ them such as their category or maintenance state. This file is regularly read by - If you are not familiar with Git/GitHub, you can have a look at our [homemade guide](https://yunohost.org/packaging_apps_git) - Don't hesitate to reach for help on the dedicated [application packaging chatroom](https://yunohost.org/chat_rooms)... we can even schedule an audio meeting to help you get started! +## Content of this repository + +### `apps.toml` + +This is the main catalog file, containing references to the apps' repositories, +along with a few metadata about them such as their category or maintenance state. + +It is regularly read by the [catalog builder](https://github.com/YunoHost/yunodevtools) +which publishes the results on . + +### `categories.toml` and `antifeatures.toml` + +Those files contain infos about apps metadatas. + +### `graveyard.toml` + +This file is for apps that are long-term not-working and unlikely to be ever revived. + +### `wishlist.toml` + +This file contains apps that users wish to be packaged. If you want to help YunoHost, check it out! + +It is [browsable online](https://apps.yunohost.org/wishlist). + +### `rejectedlist.toml` + +This file contains apps that will not be packaged, because of incompatibilities with the YunoHost project. +It is used to prevent apps to be added to the wishlist. + + ## How to add your app to the application catalog > **Note** @@ -79,7 +102,3 @@ that the app is not working anymore. Feel free to contact the app group if you feel like taking over the maintenance of a currently unmaintained app! - -## `graveyard.toml` - -This file is for apps that are long-term not-working and unlikely to be ever revived.