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 b2d5c38..22856d9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Paperless-ngx with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=paperless-ngx) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Paperless-ngx 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 Paperless-ngx 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 @@ -32,6 +32,7 @@ Paperless-ngx is a document management system that transforms your physical docu * The integrated sanity checker makes sure that your document archive is in good health. * [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html). + **Shipped version:** 2.6.3~ynh1 **Demo:** @@ -51,9 +52,9 @@ Paperless-ngx is a document management system that transforms your physical docu ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 505beba..2e7c88a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Paperless-ngx pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Paperless-ngx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=paperless-ngx) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Paperless-ngx 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 Paperless-ngx 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 @@ -32,9 +32,10 @@ Paperless-ngx is a document management system that transforms your physical docu * The integrated sanity checker makes sure that your document archive is in good health. * [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html). -**Version incluse :** 2.6.3~ynh1 -**Démo :** +**Version incluse :** 2.6.3~ynh1 + +**Démo :** ## Captures d’écran @@ -42,18 +43,18 @@ Paperless-ngx is a document management system that transforms your physical docu ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle utilisateur : -- 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 utilisateur : +- 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/paperless-ngx_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug @@ -61,4 +62,4 @@ ou sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..e3fcd99 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,65 @@ + + +# Paperless-ngx para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/paperless-ngx.svg)](https://dash.yunohost.org/appci/app/paperless-ngx) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.maintain.svg) + +[![Instalar Paperless-ngx con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=paperless-ngx) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Paperless-ngx 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 + +Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, *less paper*. + +### Features + +* Organize and index your scanned documents with tags, correspondents, types, and more. +* Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents. +* Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents). +* Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely. +* Single page application front end. +* Full text search helps you find what you need. +* Email processing: Paperless adds documents from your email accounts. +* Machine learning powered document matching. +* Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel. +* The integrated sanity checker makes sure that your document archive is in good health. +* [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html). + + +**Versión proporcionada:** 2.6.3~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de Paperless-ngx](./doc/screenshots/documents-wchrome-dark.png) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- 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/paperless-ngx_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug +ou +sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_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..54357c5 --- /dev/null +++ b/README_it.md @@ -0,0 +1,65 @@ + + +# Paperless-ngx per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/paperless-ngx.svg)](https://dash.yunohost.org/appci/app/paperless-ngx) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.maintain.svg) + +[![Installa Paperless-ngx con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=paperless-ngx) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Paperless-ngx 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 + +Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, *less paper*. + +### Features + +* Organize and index your scanned documents with tags, correspondents, types, and more. +* Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents. +* Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents). +* Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely. +* Single page application front end. +* Full text search helps you find what you need. +* Email processing: Paperless adds documents from your email accounts. +* Machine learning powered document matching. +* Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel. +* The integrated sanity checker makes sure that your document archive is in good health. +* [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html). + + +**Versione pubblicata:** 2.6.3~ynh1 + +**Prova:** + +## Screenshot + +![Screenshot di Paperless-ngx](./doc/screenshots/documents-wchrome-dark.png) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli utenti: +- 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/paperless-ngx_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/paperless-ngx_ynh/tree/testing --debug +o +sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**