From bb08cb33028a98d2da7d55f0b7e6cf548ae27d5b Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Tue, 25 May 2021 10:40:00 +0000 Subject: [PATCH] Auto-update README --- README.md | 62 +++++++++++++++++++--------------------------------- README_fr.md | 44 +++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 39 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index b5cdac0..0b9ec38 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,42 @@ + + +--- + + + # Misskey for YunoHost -[![Integration level](https://dash.yunohost.org/integration/misskey.svg)](https://dash.yunohost.org/appci/app/misskey) ![](https://ci-apps.yunohost.org/ci/badges/misskey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/misskey.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/misskey.svg)](https://dash.yunohost.org/appci/app/misskey) ![](https://ci-apps.yunohost.org/ci/badges/misskey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/misskey.maintain.svg) [![Install misskey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey) -> *This package allows you to install Misskey quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install misskey 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 -[Misskey](https://join.misskey.page/en/) is a forever evolving, sophisticated microblogging platform that support Fediverse. It provide another flavour to decentralised network. Why don't you take a short break from the hustle and bustle of the city, and dive into a new Internet? -**Shipped version:** 12.81.2 +Microblogging platform -## Screenshots +**Shipped version:** 12.81.0~ynh1 -![](https://raw.githubusercontent.com/syuilo/misskey/develop/assets/ss/user.jpg) -## Other instances to join -* [Instances](https://join.misskey.page/en/wiki/instances/) -## Important points to read before installing -1. **Misskey** require a dedicated **root domain**, eg. misskey.domain.tldYunoHost -2. **Misskey** can take quite some time to install( **more then 30 minutes** ). So take out some time and grab yourself a coffee. -3. If installing from command line use of **screen is rerecorded** to avoid disconnection.See below. -4. After installation first page can take time to load and may show timeout error. Give it time to make itself ready for you. **Refresh page after 2-3 minutes**. -5. The **first account created will be an admin user** and will have all the admin rights. -#### Support - * LDAP supported: **No** - * Can the app be used by multiple users?: **Yes** +## Documentation and resources -#### Using *screen* in case of disconnects +* Official app website: https://join.misskey.page +* Official user documentation: https://yunohost.org/apps -``` -$ sudo apt-get install screen -$ screen -$ sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh.git -``` - -Recover after disconnect: - -``` -$ screen -d -$ screen -r -``` - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/misskey_ynh/issues - * App website: https://join.misskey.page - * Upstream app repository: https://github.com/syuilo/misskey - * YunoHost website: https://yunohost.org/ - ---- +* Upstream app code repository: https://github.com/syuilo/misskey +* YunoHost documentation for this app: https://yunohost.org/app_misskey +* Report a bug: https://github.com/YunoHost-Apps/misskey_ynh/issues ## Developer info @@ -66,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/test or sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_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..1063c47 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# Misskey pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/misskey.svg)](https://dash.yunohost.org/appci/app/misskey) ![](https://ci-apps.yunohost.org/ci/badges/misskey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/misskey.maintain.svg) +[![Installer misskey avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install misskey 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.* + +## Vue d'ensemble + +Platforme de Microblogging + +**Version incluse:** 12.81.0~ynh1 + + + + + + + +## Documentations et ressources + +* Site official de l'app : https://join.misskey.page +* Documentation officielle utilisateur: https://yunohost.org/apps + +* Dépôt de code officiel de l'app: https://github.com/syuilo/misskey +* Documentation YunoHost pour cette app: https://yunohost.org/app_misskey +* Signaler un bug: https://github.com/YunoHost-Apps/misskey_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug +or +sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file