diff --git a/README.md b/README.md index 62b3d211..254af8d4 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ SirMordred is the tool used to coordinate the execution of the GrimoireLab platform, via a configuration file. Below you can find details about the different sections composing the configuration file. +## Requirements + +One good way of having an immediate sense of requirements is to look through our [`.travis.yml`](.travis.yml) file to see what our CI does to validate SirMordred. + +1. Ensure you have all the [supporting systems](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html) SirMordred needs. In particular, make sure [ElasticSearch is installed and running](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html#installing-elasticsearch). (psst: [you can do this via a docker image faster](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html#installing-elasticsearch-and-kibana-from-a-docker-container)) +2. Prepare and activate a `python3` virtualenv by following our [tutorial instructions](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/installing-grimoirelab.html#preparing-a-virtualenv). +3. Install dependencies by following the steps in our [`.travis.yml file`](.travis.yml). At the time of this writing, those are: + ```sh + pip install pandas==0.18.1 + pip install httpretty==0.8.6 + pip install -r "requirements.txt" + pip install flake8 + pip install coveralls + ``` +## Testing + +```sh +flake8 . +cd tests && ./runtests.py +``` + ## General Sections ### [es_collection] @@ -114,3 +135,4 @@ A complete list of studies parameters is available at: * **study-param-1**: .. * **study-param-2**: .. * **study-param-n**: .. +