diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index b7673fe..03008a2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Turtl with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Turtl 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 Turtl 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 @@ -50,22 +50,22 @@ Turtl is a free online service that allows you to create, synchronize and find y ## Documentation and resources -* Official app website: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug or sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8c1d919..468d5a4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Turtl pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Turtl avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Turtl 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 Turtl 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 @@ -38,34 +38,34 @@ Turtl is a free online service that allows you to create, synchronize and find y - An open-source server allows you to host your own Turtl data -**Version incluse :** 2021.03.05~ynh1 +**Version incluse :** 2021.03.05~ynh1 ## Captures d’écran ![Capture d’écran de Turtl](./doc/screenshots/screenshot.png) -## :red_circle: Fonctions indésirables +## :red_circle: Anti-fonctionnalités -- **Package not maintained**: This YunoHost package is not maintained and needs adoption. +- **Paquet non maintenu**: Ce package YunoHost n'est plus maintenu et doit être adopté. ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- 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/turtl_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug ou sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..d2bd940 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,71 @@ + + +# Turtl para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/turtl.svg)](https://dash.yunohost.org/appci/app/turtl) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/turtl.maintain.svg) + +[![Instalar Turtl con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Turtl de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner. + +### Features + +- Different note types: text, bookmark, password, image, and file/document +- Client-side cryptography to keep all of your data safe +- Securely share with anyone without compromising the security of your data +- Sharing allows different permissions ranging from read-only to full ownership of shared content +- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date +- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data. +- Browser extension makes bookmarking easy on desktop +- Share to Turtl on Android for easy bookmarking and file uploads +- Write notes in Markdown, an easy and natural way to format text +- TeX math expressions in notes for math people (surround them by $$ to use) +- Multiple translations (German, Spanish, French, and more) +- RTL text support for our Farsi/Hebrew/etc-speaking friends +- Export/import your entire profile for backup purposes or to move between servers +- Semi-offline mode (you only need to be connected to log in) +- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts) +- An open-source server allows you to host your own Turtl data + + +**Versión proporcionada:** 2021.03.05~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Turtl](./doc/screenshots/screenshot.png) + +## :red_circle: Caraterísticas cuestionables + +- **Package not maintained**: This YunoHost package is not maintained and needs adoption. + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +ou +sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..845ec57 --- /dev/null +++ b/README_it.md @@ -0,0 +1,71 @@ + + +# Turtl per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/turtl.svg)](https://dash.yunohost.org/appci/app/turtl) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/turtl.maintain.svg) + +[![Installa Turtl con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Turtl su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner. + +### Features + +- Different note types: text, bookmark, password, image, and file/document +- Client-side cryptography to keep all of your data safe +- Securely share with anyone without compromising the security of your data +- Sharing allows different permissions ranging from read-only to full ownership of shared content +- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date +- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data. +- Browser extension makes bookmarking easy on desktop +- Share to Turtl on Android for easy bookmarking and file uploads +- Write notes in Markdown, an easy and natural way to format text +- TeX math expressions in notes for math people (surround them by $$ to use) +- Multiple translations (German, Spanish, French, and more) +- RTL text support for our Farsi/Hebrew/etc-speaking friends +- Export/import your entire profile for backup purposes or to move between servers +- Semi-offline mode (you only need to be connected to log in) +- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts) +- An open-source server allows you to host your own Turtl data + + +**Versione pubblicata:** 2021.03.05~ynh1 + +## Screenshot + +![Screenshot di Turtl](./doc/screenshots/screenshot.png) + +## :red_circle: Anti-funzionalità + +- **Pacchetto non mantenuto**: Questo pacchetto di YunoHost non è più mantenuto e necessita di essere adottato. + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +o +sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**