From 56bf6e46c46345966a565710e39f8277a19e62d3 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 22 Aug 2021 06:37:17 +0000 Subject: [PATCH] Auto-update README --- README.md | 66 +++++++++++++--------------------------------------- README_fr.md | 46 ++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 50 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index d58287b..f024ae6 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,50 @@ - -# 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 - - ---- - -# Example app for YunoHost +# Spacedeck for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Integration level](https://dash.yunohost.org/integration/spacedeck.svg)](https://dash.yunohost.org/appci/app/spacedeck) ![](https://ci-apps.yunohost.org/ci/badges/spacedeck.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/spacedeck.maintain.svg) +[![Install Spacedeck with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=spacedeck) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install Spacedeck 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 -Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) +A web based, real time, collaborative whiteboard application with rich media support -**Shipped version:** 1.0~ynh1 +**Shipped version:** 2021-08-10~ynh1 -**Demo:** https://demo.example.com ## Screenshots - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/spacedeck.png) ## Disclaimers / important information -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... - -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? - - - +* The app can only be installed at the root of a domain +* There is no integration with YunoHost SSO ## Documentation and resources -* Official app website: https://example.com -* 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_example -* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Official app website: https://spacedeck.com/ +* Upstream app code repository: https://github.com/spacedeck/spacedeck-open +* YunoHost documentation for this app: https://yunohost.org/app_spacedeck +* Report a bug: https://github.com/YunoHost-Apps/spacedeck_ynh/issues ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/spacedeck_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/spacedeck_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade spacedeck -u https://github.com/YunoHost-Apps/spacedeck_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..435c526 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,46 @@ +# Spacedeck pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/spacedeck.svg)](https://dash.yunohost.org/appci/app/spacedeck) ![](https://ci-apps.yunohost.org/ci/badges/spacedeck.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/spacedeck.maintain.svg) +[![Installer Spacedeck avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=spacedeck) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Spacedeck 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 + + + +**Version incluse :** 2021-08-10~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/spacedeck.png) + +## Avertissements / informations importantes + +* The app can only be installed at the root of a domain +* There is no integration with YunoHost SSO +## Documentations et ressources + +* Site officiel de l'app : https://spacedeck.com/ +* Dépôt de code officiel de l'app : https://github.com/spacedeck/spacedeck-open +* Documentation YunoHost pour cette app : https://yunohost.org/app_spacedeck +* Signaler un bug : https://github.com/YunoHost-Apps/spacedeck_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/spacedeck_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/spacedeck_ynh/tree/testing --debug +ou +sudo yunohost app upgrade spacedeck -u https://github.com/YunoHost-Apps/spacedeck_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file