forked from YunoHost/apps
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added translation using Weblate (Hebrew)
- Loading branch information
Showing
1 changed file
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
{% if manifest.id == "example" -%} | ||
# Packaging 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 | ||
|
||
--- | ||
{% endif -%} | ||
|
||
<!-- | ||
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}} for YunoHost | ||
|
||
[![Integration level](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![Working status](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg) | ||
|
||
[![Install {{manifest.name}} with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app={{manifest.id}}) | ||
|
||
*[Lire ce readme en français.](./README_fr.md)* | ||
|
||
> *This package allows you to install {{manifest.name}} quickly and simply on a YunoHost server. | ||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* | ||
|
||
## Overview | ||
|
||
{% if description %}{{description}}{% else %}{{manifest.description[lang]}}{% endif %} | ||
**Shipped version:** {% if upstream.version %}{{upstream.version}}{% else %}{{manifest.version}} | ||
{% endif -%} | ||
|
||
{% if upstream.demo %} | ||
**Demo:** <{{upstream.demo}}> | ||
{% endif -%} | ||
|
||
{% if screenshots %} | ||
## Screenshots | ||
|
||
{% for screenshot in screenshots -%} | ||
![Screenshot of {{manifest.name}}](./{{screenshot}}) | ||
{% endfor %} | ||
{% endif -%} | ||
|
||
{% if disclaimer -%} | ||
## Disclaimers / important information | ||
|
||
{{ disclaimer }} | ||
{% endif -%} | ||
|
||
{% if antifeatures -%} | ||
## :red_circle: Antifeatures | ||
|
||
{% for antifeature in antifeatures.values() -%} | ||
- **{{ antifeature.title }}**: {{ antifeature.description }} | ||
{% endfor %} | ||
{% endif -%} | ||
|
||
## Documentation and resources | ||
|
||
{% if upstream.website -%}- Official app website: <{{ upstream.website }}> | ||
{% endif -%} | ||
{% if upstream.userdoc -%}- Official user documentation: <{{ upstream.userdoc }}> | ||
{% endif -%} | ||
{% if upstream.admindoc -%}- Official admin documentation: <{{ upstream.admindoc }}> | ||
{% endif -%} | ||
{% if upstream.code -%}- Upstream app code repository: <{{ upstream.code }}> | ||
{% endif -%} | ||
- YunoHost Store: <https://apps.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> | ||
|