diff --git a/README.md b/README.md index a62b125..62ead5d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Strut for YunoHost [![Integration level](https://dash.yunohost.org/integration/strut.svg)](https://dash.yunohost.org/appci/app/strut) ![](https://ci-apps.yunohost.org/ci/badges/strut.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/strut.maintain.svg) @@ -5,38 +10,22 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Strut 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 Strut 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 + Strut is a simple, online editor that doesn't even require registration to operate. Everything you do is recoverable and re-usable. -**Shipped version:** 20171224-1 +**Shipped version:** 20171224-1~ynh2 + +**Demo:** http://strut.io/dist/ ## Screenshots -![](https://f.cloud.github.com/assets/1009003/515405/f1003c6a-be74-11e2-84b9-14776c652afb.png) +![](./doc/screenshots/f1003c6a-be74-11e2-84b9-14776c652afb.png) -## Demo - -* [Official demo](http://strut.io/dist/) - -## Configuration - -If configuration is needed, feel free to contribute. - -## Documentation - - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/strut.svg)](https://ci-apps.yunohost.org/ci/apps/strut/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/strut.svg)](https://ci-apps-arm.yunohost.org/ci/apps/strut/) +## Disclaimers / important information ## Limitations No import/export from/to OpenDocument or pptx. @@ -49,18 +38,18 @@ Initial Strut software includes Google Analytics and is bind to Imgur to upload To avoid to take time to build this html/js app, this package setups a builded version of Strut with the patch that remove Google Analytics and Imgur dependencies. It is a build of this version https://github.com/tantaman/Strut/commits/6761b141ee7aa622916e2d23cced84ee95618cce . So it's not the more recent version. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/strut_ynh/issues - * Strut website: http://strut.io - * Strut repository: https://github.com/MohannadNaj/Strut - * YunoHost website: https://yunohost.org/ +* Official app website: http://strut.io +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://yunohost.org/packaging_apps +* Upstream app code repository: https://some.forge.com/example/example +* YunoHost documentation for this app: https://yunohost.org/app_strut +* Report a bug: https://github.com/YunoHost-Apps/strut_ynh/issues ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/strut_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/strut_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -68,3 +57,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/strut_ynh/tree/testin or sudo yunohost app upgrade strut -u https://github.com/YunoHost-Apps/strut_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 408fde6..e8d0e5e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,42 +1,28 @@ # Strut pour YunoHost -[![Niveau d'integration](https://dash.yunohost.org/integration/strut.svg)](https://dash.yunohost.org/appci/app/strut) +[![Niveau d'intégration](https://dash.yunohost.org/integration/strut.svg)](https://dash.yunohost.org/appci/app/strut) ![](https://ci-apps.yunohost.org/ci/badges/strut.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/strut.maintain.svg) [![Installer Strut avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=strut) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Strut 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* +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble + Strut est un éditeur WEB de présentations fonctionnant en HTML/JS. Tout se passe en local. Il fonctinne grâce à [impress.js](http://bartaz.github.com/impress.js/#/bored). -**Version incluse :** 20171224-1 + +**Version incluse :** 20171224-1~ynh2 + +**Démo :** http://strut.io/dist/ ## Captures d'écran -![](https://f.cloud.github.com/assets/1009003/515405/f1003c6a-be74-11e2-84b9-14776c652afb.png) +![](./doc/screenshots/f1003c6a-be74-11e2-84b9-14776c652afb.png) -## Démo - -* [Démo officielle](http://strut.io/editor/index.html) - -## Configuration - -S'il y a une configuration possible, sentez vous libre d'y contribuer. - -## Documentation - - * S'il y a une documentation spéficique, sentez vous libre d'y contribuer. - -## Caractéristiques spécifiques à YunoHost - -#### Support multi-utilisateurs - -#### Architectures supportées - -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/strut.svg)](https://ci-apps.yunohost.org/ci/apps/strut/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/strut.svg)](https://ci-apps-arm.yunohost.org/ci/apps/strut/) +## Avertissements / informations importantes ## Limitations @@ -53,14 +39,14 @@ Pour compiler le logiciel, cela nécessite grunt, ce qui ne peut pas être suppr Pour éviter de devoir générer cette application HTML/JS, ce package créé une version compilée de Strut avec le patch qui supprime les dépendances à Google Analytics et Imgur. Voici la version compilée https://github.com/tantaman/Strut/commits/6761b141ee7aa622916e2d23cced84ee95618cce. Ce n'est pas la version la plus récente. -## Liens +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/strut_ynh/issues - * Site web de Strut : http://strut.io - * Dépôt de Strut : https://github.com/MohannadNaj/Strut - * Site web de YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : http://strut.io +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Dépôt de code officiel de l'app : https://some.forge.com/example/example +* Documentation YunoHost pour cette app : https://yunohost.org/app_strut +* Signaler un bug : https://github.com/YunoHost-Apps/strut_ynh/issues ## Informations pour les développeurs @@ -72,3 +58,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/strut_ynh/tree/testin ou sudo yunohost app upgrade strut -u https://github.com/YunoHost-Apps/strut_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file