Update readme files to match consul/consul

docs/README.md

@@ -2,9 +2,9 @@
 
 This is the opensource documentation repository for [Consul](https://github.com/consul/consul), a Citizen Participation and Open Government Application
 
-* [Read English version online](https://consul_docs.gitbooks.io/docs/content/en/)
+* [Read English version](https://consul_docs.gitbooks.io/docs/content/en/)
-* [Read Spanish version online](https://consul_docs.gitbooks.io/docs/content/es/)
+* [Lee la versión en Castellano](https://consul_docs.gitbooks.io/docs/content/es/)
 
-## Local Development
+## Contributions
 
-This repo is using [GitbookIO's gitbook](https://github.com/GitbookIO/gitbook/), so check their [setup & install guide](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md) for local development.
+See [CONTRIBUTING.md](CONTRIBUTING.md)

docs/en/README.md

@@ -1,28 +1,78 @@
-# Consul Documentation
+![Logo of CONSUL](./consul_logo.png)
+
+# CONSUL
+
+Citizen Participation and Open Government Application
+
 [![Build Status](https://travis-ci.org/consul/consul.svg?branch=master)](https://travis-ci.org/consul/consul)
 [![Code Climate](https://codeclimate.com/github/consul/consul/badges/gpa.svg)](https://codeclimate.com/github/consul/consul)
+[![Dependency Status](https://gemnasium.com/consul/consul.svg)](https://gemnasium.com/consul/consul)
 [![Coverage Status](https://coveralls.io/repos/github/consul/consul/badge.svg?branch=master)](https://coveralls.io/github/consul/consul?branch=master)
+[![Crowdin](https://d322cqt584bo4o.cloudfront.net/consul/localized.svg)](https://crowdin.com/project/consul)
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)
+
 [![Accessibility conformance](https://img.shields.io/badge/accessibility-WAI:AA-green.svg)](https://www.w3.org/WAI/eval/Overview)
+[![A11y issues checked with Rocket Validator](https://rocketvalidator.com/badges/checked_with_rocket_validator.svg?url=https://rocketvalidator.com)](https://rocketvalidator.com/opensource)
 
 [![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome)
 
-## Consul core team
+This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website
 
-* Raimond García [Github](https://github.com/voodoorai2000) | [Twitter](https://twitter.com/voodoorai2000)
+## Current state
-* Alberto García Cabeza [Github](https://github.com/decabeza) | [Twitter](https://twitter.com/decabeza)
-* Alberto Calderón [Github](https://github.com/bertocq) | [Twitter](https://twitter.com/bertocq)
-* María Checa [Github](https://github.com/mariacheca)
 
-Also we want to thank their help to our wonderful [contributors](https://github.com/consul/consul/graphs/contributors) ❤️
+Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 september 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6)
 
+## Configuration for development and test environments
 
-## Tech stack
+**NOTE**: For more detailed instructions check the [docs](https://github.com/consul/docs/tree/master/en/getting_started/prerequisites)
 
-The application backend is written in the [Ruby language](https://www.ruby-lang.org/) using the [Ruby on Rails](http://rubyonrails.org/) framework.
+Prerequisites: install git, Ruby 2.3.2, bundler gem, and PostgreSQL (>=9.4).
 
-Frontend tools used include [SCSS](http://sass-lang.com/) over [Foundation](http://foundation.zurb.com/) for the styles.
+```bash
+git clone https://github.com/consul/consul.git
+cd consul
+bundle install
+cp config/database.yml.example config/database.yml
+cp config/secrets.yml.example config/secrets.yml
+bin/rake db:create
+bin/rake db:migrate
+bin/rake db:dev_seed
+RAILS_ENV=test rake db:setup
+```
 
-## Licensing
+Run the app locally:
-Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)).
+
+```
+bin/rails s
+```
+
+Prerequisites for testing: install PhantomJS >= 2.1.1
+
+Run the tests with:
+
+```
+bin/rspec
+```
+
+You can use the default admin user from the seeds file:
+
+ **user:** admin@consul.dev
+ **pass:** 12345678
+
+But for some actions like voting, you will need a verified user, the seeds file also includes one:
+
+ **user:** verified@consul.dev
+ **pass:** 12345678
+
+## Documentation
+
+You can find this project documentation at https://github.com/consul/docs
+
+## License
+
+Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt))
+
+## Contributions
+
+See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md)

docs/es/README.md

@@ -1,26 +1,79 @@
-# Documentación Consul
+![Logotipo de CONSUL](./consul_logo.png)
+
+# CONSUL
+
+Aplicación de Participación Ciudadana y Gobierno Abierto
+
 [![Build Status](https://travis-ci.org/consul/consul.svg?branch=master)](https://travis-ci.org/consul/consul)
 [![Code Climate](https://codeclimate.com/github/consul/consul/badges/gpa.svg)](https://codeclimate.com/github/consul/consul)
+[![Dependency Status](https://gemnasium.com/consul/consul.svg)](https://gemnasium.com/consul/consul)
 [![Coverage Status](https://coveralls.io/repos/github/consul/consul/badge.svg?branch=master)](https://coveralls.io/github/consul/consul?branch=master)
+[![Crowdin](https://d322cqt584bo4o.cloudfront.net/consul/localized.svg)](https://crowdin.com/project/consul)
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)
+
 [![Accessibility conformance](https://img.shields.io/badge/accessibility-WAI:AA-green.svg)](https://www.w3.org/WAI/eval/Overview)
+[![A11y issues checked with Rocket Validator](https://rocketvalidator.com/badges/checked_with_rocket_validator.svg?url=https://rocketvalidator.com)](https://rocketvalidator.com/opensource)
 
 [![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome)
 
-## Equipo de Consul
+Este es el repositorio de código abierto de la Aplicación de Participación Ciudadana CONSUL, creada originariamente por el Ayuntamiento de Madrid.
 
-* Raimond García [Github](https://github.com/voodoorai2000) | [Twitter](https://twitter.com/voodoorai2000)
+## Estado del proyecto
-* Alberto García Cabeza [Github](https://github.com/decabeza) | [Twitter](https://twitter.com/decabeza)
-* Alberto Calderón [Github](https://github.com/bertocq) | [Twitter](https://twitter.com/bertocq)
-* María Checa [Github](https://github.com/mariacheca)
 
-También queremos agradecerles sus contribuciones a nuestros maravillosos [colaboradores](https://github.com/consul/consul/graphs/contributors) ❤️
+El desarrollo de esta aplicación comenzó el [15 de Julio de 2015](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6) y el código fue puesto en producción el día 7 de Septiembre de 2015 en [decide.madrid.es](https://decide.madrid.es). Desde entonces se le añaden mejoras y funcionalidades constantemente. Las funcionalidades actuales se pueden consultar en [características](http://www.decide.es/es/) o en la [documentación](https://github.com/consul/consul/tree/master/doc) y las siguientes funcionaliades en la lista de [tareas por hacer](https://github.com/consul/consul/issues). Para conocer el estado actual de las próximas caracteristicas, vaya a [Roadmap](https://github.com/consul/consul/projects/6)
 
-## Tecnología
+## Configuración para desarrollo y tests
 
-El backend de esta aplicación se desarrolla con el lenguaje de programación [Ruby](https://www.ruby-lang.org/) sobre el *framework* [Ruby on Rails](http://rubyonrails.org/).
+**NOTA**: para unas instrucciones más detalladas consulta la [documentación](https://github.com/consul/docs/tree/master/es/getting_started/prerequisites)
-Las herramientas utilizadas para el frontend no están cerradas aún. Los estilos de la página usan [SCSS](http://sass-lang.com/) sobre [Foundation](http://foundation.zurb.com/)
+
+Prerequisitos: tener instalado git, Ruby 2.3.2, la gema `bundler` y PostgreSQL (9.4 o superior).
+
+```
+
+git clone https://github.com/consul/consul.git
+cd consul
+bundle install
+cp config/database.yml.example config/database.yml
+cp config/secrets.yml.example config/secrets.yml
+bin/rake db:create
+bin/rake db:migrate
+bin/rake db:dev_seed
+RAILS_ENV=test rake db:setup
+```
+
+Para ejecutar la aplicación en local:
+
+```
+bin/rails s
+```
+
+Prerequisitos para los tests: tener instalado PhantomJS >= 2.1.1
+
+Para ejecutar los tests:
+
+```
+bin/rspec
+```
+
+Puedes usar el usuario administrador por defecto del fichero seeds:
+
+ **user:** admin@consul.dev
+ **pass:** 12345678
+
+Pero para ciertas acciones, como apoyar, necesitarás un usuario verificado, el fichero seeds proporciona uno:
+
+ **user:** verified@consul.dev
+ **pass:** 12345678
+
+## Documentación
+
+La documentación de este proyecto se encuentra en https://github.com/consul/docs
 
 ## Licencia
-Código publicado bajo licencia AFFERO GPL v3 (ver [LICENSE-AGPLv3.txt](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)).
+
+El código de este proyecto está publicado bajo la licencia AFFERO GPL v3 (ver [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt))
+
+## Contribuciones
+
+Ver fichero [CONTRIBUTING_ES.md](https://github.com/consul/consul/blob/master/CONTRIBUTING_ES.md)