mirror of
https://github.com/YunoHost/apps.git
synced 2024-09-03 20:06:07 +02:00
Merge pull request #1430 from OniriCorpe/readme_improvement
Readmes improvements
This commit is contained in:
yalh76
GitHub
commit
4f4145c93e
2 changed files with 48 additions and 34 deletions
|
|
@ -1,13 +1,13 @@
|
|||
{% if manifest.id == "example" -%}
|
||||
# Packaging your an app, starting from this example
|
||||
|
||||
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
- Edit the `manifest.json` with app specific info.
|
||||
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
||||
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||
- Add a `LICENSE` file for the package.
|
||||
- Edit `doc/DISCLAIMER*.md`
|
||||
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
* Edit the `manifest.json` with app specific info.
|
||||
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
||||
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||
* Add a `LICENSE` file for the package.
|
||||
* Edit `doc/DISCLAIMER*.md`
|
||||
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
|
||||
---
|
||||
{% endif -%}
|
||||
|
|
@ -19,7 +19,7 @@ It shall NOT be edited by hand.
|
|||
|
||||
# {{manifest.name}} for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
|
@ -31,15 +31,18 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %}
|
||||
|
||||
**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}
|
||||
**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}
|
||||
{% endif -%}
|
||||
|
||||
{% if upstream.demo %}**Demo:** {{upstream.demo}}{% endif %}
|
||||
{% if upstream.demo %}
|
||||
**Demo:** {{upstream.demo}}
|
||||
{% endif -%}
|
||||
|
||||
{% if screenshots -%}
|
||||
{% if screenshots %}
|
||||
## Screenshots
|
||||
|
||||
{% for screenshot in screenshots -%}
|
||||
|
||||
|
||||
{% endfor %}
|
||||
{% endif -%}
|
||||
|
||||
|
|
@ -51,26 +54,28 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
## Documentation and resources
|
||||
|
||||
{% if upstream.website -%}* Official app website: {{ upstream.website }}
|
||||
{% if upstream.website -%}* Official app website: <{{ upstream.website }}>
|
||||
{% endif -%}
|
||||
{% if upstream.userdoc -%}* Official user documentation: {{ upstream.userdoc }}
|
||||
{% if upstream.userdoc -%}* Official user documentation: <{{ upstream.userdoc }}>
|
||||
{% endif -%}
|
||||
{% if upstream.admindoc -%}* Official admin documentation: {{ upstream.admindoc }}
|
||||
{% if upstream.admindoc -%}* Official admin documentation: <{{ upstream.admindoc }}>
|
||||
{% endif -%}
|
||||
{% if upstream.code -%}* Upstream app code repository: {{ upstream.code }}
|
||||
{% if upstream.code -%}* Upstream app code repository: <{{ upstream.code }}>
|
||||
{% endif -%}
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_{{manifest.id}}
|
||||
* Report a bug: https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_{{manifest.id}}>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade {{manifest.id}} -u https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# {{manifest.name}} pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://dash.yunohost.org/appci/app/{{manifest.id}})  
|
||||
[](https://install-app.yunohost.org/?app={{manifest.id}})
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer {{manifest.name}} rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
|
@ -13,15 +17,18 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %}
|
||||
|
||||
**Version incluse :** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}{% endif %}
|
||||
**Version incluse :** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}}
|
||||
{% endif -%}
|
||||
|
||||
{% if upstream.demo %}**Démo :** {{upstream.demo}}{% endif %}
|
||||
{% if upstream.demo %}
|
||||
**Démo :** {{upstream.demo}}
|
||||
{% endif -%}
|
||||
|
||||
{% if screenshots -%}
|
||||
{% if screenshots %}
|
||||
## Captures d'écran
|
||||
|
||||
{% for screenshot in screenshots -%}
|
||||
|
||||
|
||||
{% endfor %}
|
||||
{% endif -%}
|
||||
|
||||
|
|
@ -33,26 +40,28 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
## Documentations et ressources
|
||||
|
||||
{% if upstream.website -%}* Site officiel de l'app : {{ upstream.website }}
|
||||
{% if upstream.website -%}* Site officiel de l'app : <{{ upstream.website }}>
|
||||
{% endif -%}
|
||||
{% if upstream.userdoc -%}* Documentation officielle utilisateur : {{ upstream.userdoc }}
|
||||
{% if upstream.userdoc -%}* Documentation officielle utilisateur : <{{ upstream.userdoc }}>
|
||||
{% endif -%}
|
||||
{% if upstream.admindoc -%}* Documentation officielle de l'admin : {{ upstream.admindoc }}
|
||||
{% if upstream.admindoc -%}* Documentation officielle de l'admin : <{{ upstream.admindoc }}>
|
||||
{% endif -%}
|
||||
{% if upstream.code -%}* Dépôt de code officiel de l'app : {{ upstream.code }}
|
||||
{% if upstream.code -%}* Dépôt de code officiel de l'app : <{{ upstream.code }}>
|
||||
{% endif -%}
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_{{manifest.id}}
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_{{manifest.id}}>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade {{manifest.id}} -u https://github.com/YunoHost-Apps/{{manifest.id}}_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue