From acb0e6a9acae5a85a430636fc541315bb4b4ef98 Mon Sep 17 00:00:00 2001 From: Marc Anguera Insa Date: Thu, 7 Jan 2021 13:45:56 +0100 Subject: [PATCH] maintain DOCS (README & CONTRIBUTING) only in English, as we do in the WIKI, code reviews, code itself... [ci skip] --- CONTRIBUTING.md | 26 +++++++-------- README.md | 57 +++++++++++++++++---------------- docs/CONTRIBUTING.en.md | 17 ---------- docs/README.en.md | 48 --------------------------- docs/{ => images}/ofertas.png | Bin docs/{ => images}/usuarios.png | Bin 6 files changed, 41 insertions(+), 107 deletions(-) delete mode 100644 docs/CONTRIBUTING.en.md delete mode 100644 docs/README.en.md rename docs/{ => images}/ofertas.png (100%) rename docs/{ => images}/usuarios.png (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7efd3bf7d..259042923 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,17 @@ -:globe_with_meridians: Read this [in English](docs/CONTRIBUTING.en.md) +# Contributing -# Contribuciones +Did you find a bug? Do you want to collaborate? -¿Has encontrado algún bug? ¿Quieres colaborar? +Process: +* Open a thread in [discourse](https://community.coopdevs.org/c/timeoverflow) to make sure whether it's a bug or a feature :wink: +* Once we understand what the bug is about and know the steps to reproduce we will create an issue in GitHub linking to the Discourse thread. +* Create a pull request to solve the issue. +* Report back to the discourse thread the bug has been solved linking to the pull request. -Proceso: -* Abrir un hilo en [discourse](https://community.coopdevs.org/c/timeoverflow) para aclarar si es un bug o una feature :wink: -* Una vez aclarado, si se trata de un bug, abre una issue en Github indicando los pasos para reproducirlo y cómo debería funncionar correctamente, enlaza al hilo original en discourse. -* Pull request que resuelve la issue. -* Reportar en el hilo de discourse que el bug ha sido resuelto con enlace a PR. +Visit [the getting started guide to start developing](https://github.com/coopdevs/timeoverflow/wiki/Getting-started). -Visita [la guía para empezar a desarrollar para timeoverflow](https://github.com/coopdevs/timeoverflow/wiki/Getting-started). +## Contributing with translations -## Contribuir con traducciones - -- Modifica las traducciones directamente en el proyecto [coopdevs/timeoverflow](https://www.localeapp.com/projects/10031) en Locale. -- **Eso es todo!** -- El mantenedor obtendrá las nuevas traducciones del proyecto de Locale y las publicará en Github. +- Edit the translations directly on the [coopdevs/timeoverflow](https://www.localeapp.com/projects/10031) project on `Locale`. +- **That's it!** +- The maintainer will then pull translations from the `Locale` project and push to Github. diff --git a/README.md b/README.md index 42e7a523c..4f83987e0 100644 --- a/README.md +++ b/README.md @@ -6,48 +6,49 @@ #### www.timeoverflow.org -:globe_with_meridians: Read this [in English](docs/README.en.md) +:bank: :hourglass: Time Bank management system. [Learn more about Time Banks](http://www.bdtonline.org/). -:bank: :hourglass: Sistema de gestión de Banco de Tiempo. [Saber más sobre Bancos de Tiempo](http://www.bdtonline.org/) +TimeOverflow is a software developed in an altruistic way to offer a system that +facilitates the interaction of the members and the management of the Time Banks. +The model on which we work is guided by the needs of the Time Banks that make use +of it and is prepared to be able to accommodate several Time Banks in a single installation, +for this account with three levels of privileges: superadmin, admin (only manages a bank) +and members of a bank. -TimeOverflow es un software desarrollado de manera altruista para ofrecer un sistema que facilite la interacción -de los miembros y la gestión de los Bancos de Tiempo. El modelo sobre el que se trabaja está guiado por las necesidades de los Bancos de Tiempo -que hacen uso de él y está preparado para poder albergar varios Bancos de Tiempo en una sola instalación, para ello cuenta -con tres niveles de privilegios: superadmin, admin (solo gestiona un Banco) y miembros de un Banco. +![Users list](docs/images/usuarios.png) +![Offers list](docs/images/ofertas.png) -![Lista de usuarios](docs/usuarios.png) ![Lista de ofertas](docs/ofertas.png) +TimeOverflow is divided into 2 large blocks: -TimeOverflow está dividido en 2 grandes bloques: +* **Management system for administrators** +* **Social network and online banking for users** -* **Sistema de gestión para los administradores** -* **Red social y banca on-line para los usuarios** +> **NOTE** A physical Time Bank can work only with the management block, it could happen, for example, that the vast majority of its members do not use the Internet and may want to operate only with listings, checks and a management office. -> **NOTA** Un Banco de Tiempo físico puede funcionar solo con el bloque de gestión, podría ocurrir, por ejemplo, que la inmensa mayoria de sus miembros no usen Internet y podrían querer funcionar solo con listados, cheques y una oficina de gestión. +### Management system -## Sistema de gestión +Physical Time Banks (mainly focused on TimeOverflow) often work without the Internet, perform +lists of services and members and pay the hours with heels that are finally entered in the office, therefore +the management system allows us to manage the members and their services, draw lists and keep accounting. +It is important that Bank managers (admin) have useful information about the community so that they can act on it +(for example, statistics on weak users, incident management, balance of accounts, etc.) -Los Bancos de Tiempo físicos (a los que principalmente se enfoca TimeOverflow) a menudo funcionan sin internet, se realizan -unos listados de servicios y de miembros y se pagan las horas con talones que finalmente se ingresan en la oficina, por tanto -el sistema de gestión nos permite gestionar los miembros y sus servicios, sacar listados y llevar la contabilidad. También -es importante que los gestores del Banco (admin), tengan información útil sobre la comunidad para poder actuar sobre ella -(por ejemplo, estadísticas sobre usuarios poco activos, gestión de incidencias, equilibrio de las cuentas, etc) +### Social Network and Online Banking -## Red social y banca on-line +The social network makes it easy for members to meet and meet outside the events scheduled by the Time Bank, +as well as being able to post offers / demand ads explained in detail. -La red social facilita a los miembros encontrarse y conocerse fuera de los eventos programados por el Banco de Tiempo, -así como poder publicar anuncios de ofertas/demandas explicados en detalle. +On the other hand the members can be paid the services of virtual way to save the passage through the office of the Bank +of Time and also have the possibility to consult the extract of their account. -Por otro lado los miembros pueden pagarse los servicios de manera virtual para ahorrarse el paso por la oficina del Banco -de Tiempo y también tienen la posibilidad de consultar el extracto de su cuenta. +## Contributions -# Contribuciones +**Join our collaborators team!** -**Únete al equipo de colaboradores!** +:point_right: Further information [here](CONTRIBUTING.md). -:point_right: Más información [aquí](CONTRIBUTING.md). - -# Licencia +## License > The Unlicense -Puedes consultar la licencia [aquí](UNLICENSE). +You can find the license file [here](UNLICENSE). diff --git a/docs/CONTRIBUTING.en.md b/docs/CONTRIBUTING.en.md deleted file mode 100644 index 3e168d3ca..000000000 --- a/docs/CONTRIBUTING.en.md +++ /dev/null @@ -1,17 +0,0 @@ -# Contributing - -Did you find a bug? Do you want to collaborate? - -Process: -* Open a thread in [discourse](https://community.coopdevs.org/c/timeoverflow) to make sure whether it's a bug or a feature :wink: -* Once we understand what the bug is about and know the steps to reproduce we will create an issue in GitHub linking to the Discourse thread. -* Create a pull request to solve the issue. -* Report back to the discourse thread the bug has been solved linking to the pull request. - -Visit [the getting started guide to start developing](https://github.com/coopdevs/timeoverflow/wiki/Getting-started). - -## Contributing with translations - -- Edit the translations directly on the [coopdevs/timeoverflow](https://www.localeapp.com/projects/10031) project on Locale. -- **That's it!** -- The maintainer will then pull translations from the Locale project and push to Github. diff --git a/docs/README.en.md b/docs/README.en.md deleted file mode 100644 index 2440cb485..000000000 --- a/docs/README.en.md +++ /dev/null @@ -1,48 +0,0 @@ -# TimeOverflow [![Build Status](https://travis-ci.org/coopdevs/timeoverflow.svg)](https://travis-ci.org/coopdevs/timeoverflow) [![Code Climate](https://codeclimate.com/github/timeoverflow/timeoverflow/badges/gpa.svg)](https://codeclimate.com/github/timeoverflow/timeoverflow) -#### https://www.timeoverflow.org/ - -:bank: :hourglass: Time Bank management system. [Learn more about Time Banks](http://www.bdtonline.org/) - -TimeOverflow is a software developed in an altruistic way to offer a system that -facilitates the interaction of the members and the management of the Time Banks. -The model on which we work is guided by the needs of the Time Banks that make use -of it and is prepared to be able to accommodate several Time Banks in a single installation, -for this account with three levels of privileges: superadmin, admin (only manages a bank) -and members of a bank. - -![Users list](usuarios.png) ![Offers list](ofertas.png) - -TimeOverflow is divided into 2 large blocks: - -* **Management system for administrators** -* **Social network and online banking for users** - -> **NOTE** A physical Time Bank can work only with the management block, it could happen, for example, that the vast majority of its members do not use the Internet and may want to operate only with listings, checks and a management office. - -## Management system - -Physical Time Banks (mainly focused on TimeOverflow) often work without the Internet, perform -lists of services and members and pay the hours with heels that are finally entered in the office, therefore -the management system allows us to manage the members and their services, draw lists and keep accounting. -It is important that Bank managers (admin) have useful information about the community so that they can act on it -(for example, statistics on weak users, incident management, balance of accounts, etc.) - -## Social Network and Online Banking - -The social network makes it easy for members to meet and meet outside the events scheduled by the Time Bank, -as well as being able to post offers / demand ads explained in detail. - -On the other hand the members can be paid the services of virtual way to save the passage through the office of the Bank -of Time and also have the possibility to consult the extract of their account. - -# Contributions - -**Join our collaborators team!** - -:point_right: Further information [here](CONTRIBUTING.en.md). - -# License - -> The Unlicense - -You can find the license file [here](../UNLICENSE). \ No newline at end of file diff --git a/docs/ofertas.png b/docs/images/ofertas.png similarity index 100% rename from docs/ofertas.png rename to docs/images/ofertas.png diff --git a/docs/usuarios.png b/docs/images/usuarios.png similarity index 100% rename from docs/usuarios.png rename to docs/images/usuarios.png