mirror of
https://github.com/YunoHost-Apps/joplin_ynh.git
synced 2024-09-03 19:36:03 +02:00
47 lines
2 KiB
Markdown
47 lines
2 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Joplin for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/joplin/)  
|
|
|
|
[](https://install-app.yunohost.org/?app=joplin)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Joplin 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
|
|
|
|
Joplin server is a note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
|
|
|
|
**Shipped version:** 3.1.6~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://joplinapp.org/>
|
|
- Official admin documentation: <https://joplinapp.org/help/>
|
|
- Upstream app code repository: <https://github.com/laurent22/joplin/>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/joplin>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/joplin_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/joplin_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/joplin_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade joplin -u https://github.com/YunoHost-Apps/joplin_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|