diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..d6e8f9c --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,4 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) diff --git a/README.md b/README.md index 51029e2..a6be1e8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,45 +9,22 @@ It shall NOT be edited by hand. [![Install Misskey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.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.* +> *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 is a decentralized microblogging platform. Since it exists within the Fediverse (a universe where various social media platforms are organized), it is mutually linked with other social media platforms. + **Shipped version:** 12.119.2~ynh1 ## Screenshots ![Screenshot of Misskey](./doc/screenshots/screenshot-desktop.png) -## Disclaimers / important information - -### Important points to read before installing - -- *Misskey* requires a dedicated root domain, e.g. `misskey.domain.tld` -- Due to Cypress dependency, *Misskey* only works on 64-bit CPU machines. -- *Misskey* can take quite some time to install (more then 30 minutes). So take out some time and grab yourself a coffee. -- If installing from command line, using `screen` is recommended to avoid disconnection. See below. -- After installation, first page can take time to load and may show timeout error. Give it time to make itself ready for you. Refresh the page after 2 or 3 minutes. -- The first account created will be an admin user and will have all the admin rights. - -Using screen in case of disconnects - -``` -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 -``` - ## Documentation and resources - Official app website: @@ -57,9 +34,9 @@ screen -r ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 3ae8c91..234d74e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Misskey pour YunoHost @@ -9,56 +9,33 @@ It shall NOT be edited by hand. [![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 le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Misskey 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.* +> *Ce package vous permet d’installer Misskey rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble Misskey est une plateforme de microblogging décentralisée. Puisqu'il existe au sein du Fediverse (un univers où diverses plateformes de médias sociaux sont organisées), il est mutuellement lié à d'autres plateformes de médias sociaux. -**Version incluse :** 12.119.2~ynh1 + +**Version incluse :** 12.119.2~ynh1 ## Captures d’écran ![Capture d’écran de Misskey](./doc/screenshots/screenshot-desktop.png) -## Avertissements / informations importantes - -### Points importants à lire avant l'installation - -- *Misskey* nécessite un domaine racine dédié, par ex. `misskey.domain.tld` -- En raison de la dépendance de Cypress, *Misskey* ne fonctionne que sur les machines à processeur 64 bits. -- *Misskey* peut prendre un certain temps à installer (plus de 30 minutes). Alors prenez un peu de temps et prenez un café. -- Si l'installation à partir de la ligne de commande, l'utilisation de l'écran est réenregistrée pour éviter la déconnexion. Voir ci-dessous. -- Après l'installation, la première page peut prendre du temps à charger et peut afficher une erreur de délai d'attente. Donnez-lui le temps de se préparer pour vous. Actualiser la page après 2-3 minutes. -- Le premier compte créé sera un utilisateur administrateur et disposera de tous les droits d'administrateur. - -Utiliser *screen* en cas de déconnexion - -``` -sudo apt-get install screen -screen -sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh.git -``` -Récupérer après déconnexion : -``` -screen -d -screen -r -``` - ## Documentations et ressources -- Site officiel de l’app : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). +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. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug @@ -66,4 +43,4 @@ ou sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :**