diff --git a/README.md b/README.md index 484f3b7..2693063 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,54 @@ + + # Trilium Notes for YunoHost -[![Integration level](https://dash.yunohost.org/integration/trilium.svg)](https://dash.yunohost.org/appci/app/trilium) ![](https://ci-apps.yunohost.org/ci/badges/trilium.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/trilium.maintain.svg) -[![Install trilium with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trilium) +[![Integration level](https://dash.yunohost.org/integration/trilium.svg)](https://dash.yunohost.org/appci/app/trilium) ![Working status](https://ci-apps.yunohost.org/ci/badges/trilium.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/trilium.maintain.svg) +[![Install Trilium Notes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trilium) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Trilium Notes and simply on a YunoHost server. +> *This package allows you to install Trilium Notes 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 + Trilium Notes is an Evernote-like hierarchical note taking application with many advanced features, focused on building a large personal knowledge base. -**Shipped version:** 0.52.3 + +**Shipped version:** 0.52.3~ynh2 ## Screenshots -![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) +![Screenshot of Trilium Notes](./doc/screenshots/screenshot.png) +![Screenshot of Trilium Notes](./doc/screenshots/example.jpg) + +## Disclaimers / important information ## Configuration You will be asked to choose a username and password when you first access the app. You can configure Trillium from the settings menu of the app interface. -## Documentation +## Documentation and resources - * Official documentation: https://github.com/zadam/trilium/wiki - -#### Multi-user support - -Are LDAP and HTTP auth supported? **No** -Can the app be used by multiple users? **No** - -#### Supported architectures - -* x86-64 -* ARMv8-A - -## Links - -* Report a bug: https://github.com/YunoHost-Apps/trilium_ynh/issues -* Upstream app repository: https://github.com/zadam/trilium -* YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/trilium_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug or sudo yunohost app upgrade trilium -u https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index e0574c1..4eed8dc 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,56 +1,54 @@ + + # Trilium Notes pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/trilium.svg)](https://dash.yunohost.org/appci/app/trilium) ![](https://ci-apps.yunohost.org/ci/badges/trilium.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/trilium.maintain.svg) -[![Installer trilium avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trilium) +[![Niveau d'intégration](https://dash.yunohost.org/integration/trilium.svg)](https://dash.yunohost.org/appci/app/trilium) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/trilium.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/trilium.maintain.svg) +[![Installer Trilium Notes avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trilium) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer Trilium Notes rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Trilium Notes 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 + Trilium Notes est une application de prise de note hiérarchique semblable a Evernote, avec maintes fonctions avancées, centrée sur la construction d'une large base de connaissances personnelle. -**Version incluse :** 0.52.3 + +**Version incluse :** 0.52.3~ynh2 ## Captures d'écran -![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) +![Capture d'écran de Trilium Notes](./doc/screenshots/screenshot.png) +![Capture d'écran de Trilium Notes](./doc/screenshots/example.jpg) + +## Avertissements / informations importantes ## Configuration On vous demandera de choisir un nom d'utilisateur et mot de passe quand vous installez l'application. Vous pouvez configurer Trillium depuis le menu de configuration de l'interface web. -## Documentation +## Documentations et ressources -* Documentation officielle : https://github.com/zadam/trilium/wiki - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Non** - -#### Architectures supportées - -* x86-64 -* ARMv8-A - -## Liens - -* Signaler un bug : https://github.com/YunoHost-Apps/trilium_ynh/issues -* Dépôt de l'application principale : https://github.com/zadam/trilium -* Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/trilium_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug ou sudo yunohost app upgrade trilium -u https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**