diff --git a/README.md b/README.md index 6647afe..55cc1fd 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,52 @@ + + # SVG-edit for YunoHost -[![Integration level](https://dash.yunohost.org/integration/svgedit.svg)](https://dash.yunohost.org/appci/app/svgedit) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/svgedit.svg)](https://dash.yunohost.org/appci/app/svgedit) ![Working status](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/svgedit.maintain.svg) [![Install SVG-edit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=svgedit) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install SVG-edit quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install SVG-edit 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 + SVG-edit is a fast, web-based, javascript-driven SVG drawing editor that works in any modern browser. -**Shipped version:** 2.8.1 + +**Shipped version:** 2.8.1~ynh4 ## Screenshots -![](https://raw.githubusercontent.com/SVG-Edit/svgedit/master/docs/screenshot.png) +![Screenshot of SVG-edit](./doc/screenshots/screenshot.png) -## Demo - -* [Official demo](https://svg-edit.github.io/svgedit/dist/editor/index.html) - -## Configuration - -## Documentation - -* Official documentation: Link to the official documentation of this app -* YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-users support - -Not supported. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/svgedit.svg)](https://ci-apps.yunohost.org/ci/apps/svgedit/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/svgedit.svg)](https://ci-apps-arm.yunohost.org/ci/apps/svgedit/) +## Disclaimers / important information ## Limitations There is no account management in SVG-edit, but the SSO can protect the access to the app to disallow user without YunoHost account. -## Additionnal informations +## Documentation and resources -## Links +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: - * Report a bug: https://github.com/YunoHost-Apps/svgedit_ynh/issues - * Website: https://github.com/SVG-Edit/svgedit - * YunoHost website: https://yunohost.org/ +## Developer info ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing). To try the testing branch, please proceed like that. -``` -sudo yunohost app install https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --verbose + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --debug or -sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --verbose +sudo yunohost app upgrade svgedit -u https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index e5a866c..c4864ef 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,65 +1,52 @@ + + # SVG-edit pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/svgedit.svg)](https://dash.yunohost.org/appci/app/svgedit) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/svgedit.svg)](https://dash.yunohost.org/appci/app/svgedit) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/svgedit.maintain.svg) [![Installer SVG-edit avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=svgedit) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer SVG-edit rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer SVG-edit 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.* ## Vue d'ensemble + SVG-edit est un éditeur de dessin SVG rapide, basé sur le Web et piloté par JavaScript, qui fonctionne dans n'importe quel navigateur moderne. -**Version incluse :** 2.8.1 + +**Version incluse :** 2.8.1~ynh4 ## Captures d'écran -![](https://raw.githubusercontent.com/SVG-Edit/svgedit/master/docs/screenshot.png) +![Capture d'écran de SVG-edit](./doc/screenshots/screenshot.png) -## Démo - -* [Démo officielle](https://svg-edit.github.io/svgedit/dist/editor/index.html) - -## Configuration - -## Documentation - -* Documentation officielle : Lien vers la documentation officielle de cette application. -* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -Non supporté. - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/svgedit.svg)](https://ci-apps.yunohost.org/ci/apps/svgedit/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/svgedit.svg)](https://ci-apps-arm.yunohost.org/ci/apps/svgedit/) +## Avertissements / informations importantes ## Limitations -Il n'y a pas de gestion de compte dans SVG-edit, mais le SSO peut protéger l'accès à l'application pour interdire l'utilisateur sans compte YunoHost. +Il n'y a pas de gestion de compte dans SVG-edit, mais le SSO peut protéger l'accès à l'application pour interdire les utilisateurs sans compte YunoHost. -## Informations additionnelles +## Documentations et ressources -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/svgedit_ynh/issues - * Dépôt de l'application principale : https://github.com/SVG-Edit/svgedit - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --debug +ou +sudo yunohost app upgrade svgedit -u https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --debug ``` -sudo yunohost app install https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --verbose -or -sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/svgedit_ynh/tree/testing --verbose -``` + +**Plus d'infos sur le packaging d'applications :**