diff --git a/README.md b/README.md index 7d69dfdd..3536467f 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,23 @@ -Here you will find the repositories and versions of every apps available in YunoHost's default catalog. +This repository contains the default YunoHost app catalog, as well as tools +that can be run manually or automatically. -It is browsable here: https://yunohost.org/apps +The catalog is stored in [**`apps.toml`**](./apps.toml) and is browsable here: + -The main file of the catalog is [**apps.toml**](./apps.toml) which contains -references to the corresponding Git repositories for each application, along -with a few metadata about them such as its category or maintenance state. This -file regularly read by `list_builder.py` which publish the results on -https://app.yunohost.org/default/. +It contains refences to the apps' repositories, along with a few metadata about +them such as its category or maintenance state. This file is regularly read by +`list_builder.py` which publish the results on . -### Where can I learn about app packaging in YunoHost? +## Where can I learn about app packaging in YunoHost? -- You can browse the contributor documentation : https://yunohost.org/contributordoc +- You can browse [the contributor documentation](https://yunohost.org/contributordoc) - 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! -### How to add your app to the application catalog +## How to add your app to the application catalog > **Note** > The YunoHost project will **NOT** integrate in its catalog applications that are not @@ -30,16 +30,20 @@ https://app.yunohost.org/default/. > with keeping your app working and up to date with packaging evolutions on the long run. To add your application to the catalog: -* Fork this repository and edit the [apps.toml](https://github.com/YunoHost/apps/tree/master/apps.toml) file -* Add your app's ID and git information at the right alphabetical place -* Indicate the app's functioning state: `notworking`, `inprogress`, or `working` -* Indicate the app category, which you can pick from `categories.toml` -* Indicate any anti-feature that your app may be subject to, see `antifeatures.toml` (or remove the `antifeatures` key if there's none) -* Indicate if your app can be thought of as an alternative to popular proprietary services (or remove the `potential_alternative_to` key if there's none) -* *Do not* add the `level` entry by yourself. Our automatic test suite ("the CI") will handle it. + +* Fork [this repository](https://github.com/YunoHost/apps) +* Edit the [`apps.toml`](/apps.toml) file + * Add your app's ID and git information at the right alphabetical place + * Indicate the app's functioning state: `notworking`, `inprogress`, or `working` + * Indicate the app category, which you can pick from `categories.toml` + * Indicate any anti-feature that your app may be subject to, see `antifeatures.toml` (or remove the `antifeatures` key if there's none) + * Indicate if your app can be thought of as an alternative to popular proprietary services (or remove the `potential_alternative_to` key if there's none) + * *Do not* add the `level` entry by yourself. Our automatic test suite ("the CI") will handle it. +* Commit and push your modifications to your repository * Create a [Pull Request](https://github.com/YunoHost/apps/pulls/) App example addition: + ```toml [your_app] antifeatures = [ "deprecated-software" ] # Remove if no relevant antifeature applies @@ -58,17 +62,23 @@ url = "https://github.com/YunoHost-Apps/your_app_ynh" > obtain an access to the developer CI where you'll be able to test your app > easily. -### Updating apps levels in the catalog +## Updating apps levels in the catalog -App packagers should *not* manually set their apps' level. The levels of all the apps are automatically updated once per week on Friday, according to the results from the official app CI. +App packagers should *not* manually set their apps' level. The levels of all +the apps are automatically updated once per week on Friday, according to the +results from the official app CI. -### Apps flagged as not-maintained +## Apps flagged as not-maintained -Applications with no recent activity and no active sign from maintainer may be flagged in `apps.toml` with the `package-not-maintained` antifeature tag to signify that the app is inactive and may slowly become outdated with respect to the upstream, or with respect to good packaging practices. It does **not** mean that the app is not working anymore. +Applications with no recent activity and no active sign from maintainer may be +flagged in `apps.toml` with the `package-not-maintained` antifeature tag to +signify that the app is inactive and may slowly become outdated with respect to +the upstream, or with respect to good packaging practices. It does **not** mean +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! +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 +## `graveyard.toml` +This file is for apps that are long-term not-working and unlikely to be ever revived. diff --git a/store/README.md b/store/README.md index b60700be..c0c598d0 100644 --- a/store/README.md +++ b/store/README.md @@ -4,7 +4,7 @@ This is a Flask app interfacing with YunoHost's app catalog for a cool browsing ## Developement -``` +```bash python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt @@ -19,22 +19,22 @@ curl https://app.yunohost.org/default/v3/apps.json > ../builds/default/v3/apps.j # You will also want to run list_builder.py to initialize the .apps_cache (at least for a few apps, you can Ctrl+C after a while) pushd .. - python3 list_builder.py + ./list_builder.py popd ``` And then start the dev server: -``` +```bash source venv/bin/activate FLASK_APP=app.py FLASK_ENV=development flask run ``` ## Translation -It's based on Flask-Babel : https://python-babel.github.io/ +It's based on Flask-Babel : -``` +```bash source venv/bin/activate pybabel extract --ignore-dirs venv -F babel.cfg -o messages.pot .