diff --git a/README.md b/README.md index 6916fcf..36d225c 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ It shall NOT be edited by hand. # Calckey for YunoHost [![Integration level](https://dash.yunohost.org/integration/calckey.svg)](https://dash.yunohost.org/appci/app/calckey) ![Working status](https://ci-apps.yunohost.org/ci/badges/calckey.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/calckey.maintain.svg) + [![Install Calckey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=calckey) *[Lire ce readme en français.](./README_fr.md)* @@ -32,30 +33,6 @@ A greatly enhanced fork of Misskey with better UI/UX, security, features, and mo ![Screenshot of Calckey](./doc/screenshots/screenshot-calckey.png) -## Disclaimers / important information - -### Important points to read before installing - -- *Calckey* requires a dedicated root domain, e.g. `Calckey.domain.tld` -- Due to Cypress dependency, *Calckey* only works on 64-bit CPU machines. -- *Calckey* 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/Calckey_ynh.git -``` -Recover after disconnect: -``` -screen -d -screen -r -``` - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index e491ddc..3561cae 100644 --- a/README_fr.md +++ b/README_fr.md @@ -6,6 +6,7 @@ It shall NOT be edited by hand. # Calckey pour YunoHost [![Niveau d’intégration](https://dash.yunohost.org/integration/calckey.svg)](https://dash.yunohost.org/appci/app/calckey) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/calckey.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/calckey.maintain.svg) + [![Installer Calckey avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=calckey) *[Read this readme in english.](./README.md)* @@ -30,30 +31,6 @@ Un fork grandement amélioré de Misskey avec une meilleure UI/UX, sécurité, f ![Capture d’écran de Calckey](./doc/screenshots/screenshot-calckey.png) -## Avertissements / informations importantes - -### Points importants à lire avant l'installation - -- *Calckey* nécessite un domaine racine dédié, par ex. `Calckey.domain.tld` -- En raison de la dépendance de Cypress, *Calckey* ne fonctionne que sur les machines à processeur 64 bits. -- *Calckey* 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/Calckey_ynh.git -``` -Récupérer après déconnexion : -``` -screen -d -screen -r -``` - ## Documentations et ressources * Site officiel de l’app :