1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/trilium_ynh.git synced 2024-10-01 13:34:49 +02:00
trilium_ynh/README.md

54 lines
2.2 KiB
Markdown
Raw Normal View History

2022-07-03 23:32:07 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2021-03-31 19:55:10 +02:00
# Trilium Notes for YunoHost
2021-03-29 16:24:15 +02:00
2022-07-03 23:32:07 +02:00
[![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)
2021-03-29 16:24:15 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-07-03 23:32:07 +02:00
> *This package allows you to install Trilium Notes quickly and simply on a YunoHost server.
2021-03-29 16:24:15 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-07-03 23:32:07 +02:00
2021-05-21 22:26:51 +02:00
Trilium Notes is an Evernote-like hierarchical note taking application with many advanced features, focused on building a large personal knowledge base.
2021-03-29 16:24:15 +02:00
2022-07-03 23:32:07 +02:00
2022-09-25 15:36:06 +02:00
**Shipped version:** 0.55.1~ynh1
2021-03-29 16:24:15 +02:00
## Screenshots
2022-07-03 23:32:07 +02:00
![Screenshot of Trilium Notes](./doc/screenshots/screenshot.png)
![Screenshot of Trilium Notes](./doc/screenshots/example.jpg)
## Disclaimers / important information
2021-03-29 16:24:15 +02:00
## Configuration
2021-05-21 22:26:51 +02:00
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.
2021-03-29 16:24:15 +02:00
2022-07-03 23:32:07 +02:00
## Documentation and resources
2021-03-29 16:24:15 +02:00
2022-07-03 23:32:07 +02:00
* Official admin documentation: <https://github.com/zadam/trilium/wiki>
* Upstream app code repository: <https://github.com/zadam/trilium>
* YunoHost documentation for this app: <https://yunohost.org/app_trilium>
* Report a bug: <https://github.com/YunoHost-Apps/trilium_ynh/issues>
2021-03-29 16:24:15 +02:00
## Developer info
2021-03-31 19:55:10 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/trilium_ynh/tree/testing).
2021-03-29 16:24:15 +02:00
To try the testing branch, please proceed like that.
2022-07-03 23:32:07 +02:00
``` bash
2021-03-31 19:55:10 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug
2021-03-29 16:24:15 +02:00
or
2021-03-31 19:55:10 +02:00
sudo yunohost app upgrade trilium -u https://github.com/YunoHost-Apps/trilium_ynh/tree/testing --debug
2021-03-29 16:24:15 +02:00
```
2022-07-03 23:32:07 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>