diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..a01b345 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index 676990f..8dfe85c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Armadietto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install Armadietto 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 Armadietto 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 @@ -37,27 +37,31 @@ This option can be enabled in the configuration panel. [Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option. -**Shipped version:** 0.2.0~ynh2 +**Shipped version:** 0.2.0~ynh3 ## Screenshots ![Screenshot of Armadietto](./doc/screenshots/armadietto-welcome.png) ![Screenshot of Armadietto](./doc/screenshots/armadietto-signup.png) +## :red_circle: Antifeatures + +- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability. + ## Documentation and resources -* Official app website: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- 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/armadietto_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/armadietto_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/armadietto_ynh/tree/testing --debug or sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..cafcb9c --- /dev/null +++ b/README_eu.md @@ -0,0 +1,70 @@ + + +# Armadietto YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) + +[![Instalatu Armadietto YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Armadietto YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js. + +Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)). + +> ### :warning: WARNING +> Please do not consider `armadietto` production ready, this project is still +> considered experimental. As with any alpha-stage storage technology, you +> MUST expect that it will eat your data and take precautions against this. You +> SHOULD expect that its APIs and storage schemas will change before it is +> labelled stable. + +### Installation option + +User registration is not allowed out of the box. +This option can be enabled in the configuration panel. + +### Application for remoteStorage + +[Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option. + + +**Paketatutako bertsioa:** 0.2.0~ynh3 + +## Pantaila-argazkiak + +![Armadietto(r)en pantaila-argazkia](./doc/screenshots/armadietto-welcome.png) +![Armadietto(r)en pantaila-argazkia](./doc/screenshots/armadietto-signup.png) + +## :red_circle: Ezaugarri zalantzagarriak + +- **Alfa softwarea**: Garapenaren hasierako fasean dago. Ezaugarri aldakor edo ezegonkorrak, erroreak eta segurtasuneko arazoak izan ditzazke. + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +edo +sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index a48ee31..a9e4874 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Armadietto pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Armadietto avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Armadietto 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 Armadietto 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 @@ -37,30 +37,34 @@ Cette option peut être activée via le panneau de configutration. [Cliquez ici](https://remotestorage.io/apps/) pour voir une liste non exhaustive d'applications ayant intégré remoteStorage comme option de stockage/synchronisation. -**Version incluse :** 0.2.0~ynh2 +**Version incluse :** 0.2.0~ynh3 ## Captures d’écran ![Capture d’écran de Armadietto](./doc/screenshots/armadietto-welcome.png) ![Capture d’écran de Armadietto](./doc/screenshots/armadietto-signup.png) +## :red_circle: Anti-fonctionnalités + +- **Logiciel en version alpha **: Le logiciel est au tout début de son développement. Il pourrait contenir des fonctionnalités changeantes ou instables, des bugs, et des failles de sécurité. + ## Documentations et ressources -* Site officiel de l’app : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- 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/armadietto_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/armadietto_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/armadietto_ynh/tree/testing --debug ou sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_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..21e45a9 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,70 @@ + + +# Armadietto para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) + +[![Instalar Armadietto con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Armadietto 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 + +[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js. + +Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)). + +> ### :warning: WARNING +> Please do not consider `armadietto` production ready, this project is still +> considered experimental. As with any alpha-stage storage technology, you +> MUST expect that it will eat your data and take precautions against this. You +> SHOULD expect that its APIs and storage schemas will change before it is +> labelled stable. + +### Installation option + +User registration is not allowed out of the box. +This option can be enabled in the configuration panel. + +### Application for remoteStorage + +[Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option. + + +**Versión proporcionada:** 0.2.0~ynh3 + +## Capturas de pantalla + +![Captura de pantalla de Armadietto](./doc/screenshots/armadietto-welcome.png) +![Captura de pantalla de Armadietto](./doc/screenshots/armadietto-signup.png) + +## :red_circle: Caraterísticas cuestionables + +- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability. + +## Documentación e recursos + +- Web oficial da app: +- 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/armadietto_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +ou +sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 0000000..17ca536 --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,70 @@ + + +# YunoHost 的 Armadietto + +[![集成程度](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![工作状态](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) + +[![使用 YunoHost 安装 Armadietto](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Armadietto。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js. + +Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)). + +> ### :warning: WARNING +> Please do not consider `armadietto` production ready, this project is still +> considered experimental. As with any alpha-stage storage technology, you +> MUST expect that it will eat your data and take precautions against this. You +> SHOULD expect that its APIs and storage schemas will change before it is +> labelled stable. + +### Installation option + +User registration is not allowed out of the box. +This option can be enabled in the configuration panel. + +### Application for remoteStorage + +[Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option. + + +**分发版本：** 0.2.0~ynh3 + +## 截图 + +![Armadietto 的截图](./doc/screenshots/armadietto-welcome.png) +![Armadietto 的截图](./doc/screenshots/armadietto-signup.png) + +## :red_circle: 负面特征 + +- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability. + +## 文档与资源 + +- 官方应用网站： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +或 +sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**