diff --git a/README.md b/README.md index 1078b7c..efe1fe5 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,44 @@ -# Scratch app for YunoHost -Scratch Server + -- [Yunohost project](https://yunohost.org) -- [Scratch website](https://scratch.mit.edu/) +# Scratch for YunoHost -![](http://maths.enseigne.ac-lyon.fr/spip/local/cache-vignettes/L800xH267/scratch_large-d88bc.jpg) +[![Integration level](https://dash.yunohost.org/integration/scratch.svg)](https://dash.yunohost.org/appci/app/scratch) ![](https://ci-apps.yunohost.org/ci/badges/scratch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scratch.maintain.svg) +[![Install Scratch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scratch) +*[Lire ce readme en français.](./README_fr.md)* -[![Install Scratch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=scratch) +> *This package allows you to install Scratch 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.* -### Installing guide +## Overview - App can be installed by YunoHost **admin web-interface** or by **running following command**: +Scratch package for YunoHost. - $ sudo yunohost app install https://github.com/YunoHost-Apps/scratch_ynh - Admin username is : **root**. +**Shipped version:** 3.0-Beta~ynh1 - -### Upgrade this package: +**Demo:** https://demo.example.com - $ sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/scratch_ynh +## Documentation and resources +* Official app website: https://scratch.mit.edu/ +* 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_scratch +* Report a bug: https://github.com/YunoHost-Apps/scratch_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/scratch_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/scratch_ynh/tree/testing --debug +or +sudo yunohost app upgrade scratch -u https://github.com/YunoHost-Apps/scratch_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 new file mode 100644 index 0000000..e829761 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# Scratch pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/scratch.svg)](https://dash.yunohost.org/appci/app/scratch) ![](https://ci-apps.yunohost.org/ci/badges/scratch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scratch.maintain.svg) +[![Installer Scratch avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scratch) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Scratch 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 + +Scratch pour YunoHost. + +**Version incluse :** 3.0-Beta~ynh1 + +**Démo :** https://demo.example.com + +## Documentations et ressources + +* Site officiel de l'app : https://scratch.mit.edu/ +* 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_scratch +* Signaler un bug : https://github.com/YunoHost-Apps/scratch_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/scratch_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/scratch_ynh/tree/testing --debug +ou +sudo yunohost app upgrade scratch -u https://github.com/YunoHost-Apps/scratch_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file