diff --git a/README.md b/README.md
index a87846e..7c95c31 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
-
+
[](https://circleci.com/gh/deezer/spleeter/tree/master)  [](https://badge.fury.io/py/spleeter) [](https://anaconda.org/conda-forge/spleeter) [](https://hub.docker.com/r/researchdeezer/spleeter) [](https://colab.research.google.com/github/deezer/spleeter/blob/master/spleeter.ipynb) [](https://gitter.im/spleeter/community)
-
-
## About
**Spleeter** is the [Deezer](https://www.deezer.com/) source separation library with pretrained models
@@ -15,42 +13,49 @@ already trained state of the art model for performing various flavour of separat
* Vocals / drums / bass / other separation ([4 stems](https://github.com/deezer/spleeter/wiki/2.-Getting-started#using-4stems-model))
* Vocals / drums / bass / piano / other separation ([5 stems](https://github.com/deezer/spleeter/wiki/2.-Getting-started#using-5stems-model))
-2 stems and 4 stems models have state of the art performances on the [musdb](https://sigsep.github.io/datasets/musdb.html) dataset. **Spleeter** is also very fast as it can perform separation of audio files to 4 stems 100x faster than real-time when run on a GPU.
+2 stems and 4 stems models have state of the art performances on the [musdb](https://sigsep.github.io/datasets/musdb.html) dataset. **Spleeter** is also very fast as it can perform separation of audio files to 4 stems 100x faster than real-time when run on a GPU.
We designed **Spleeter** so you can use it straight from [command line](https://github.com/deezer/spleeter/wiki/2.-Getting-started#usage)
as well as directly in your own development pipeline as a [Python library](https://github.com/deezer/spleeter/wiki/4.-API-Reference#separator). It can be installed with [Conda](https://github.com/deezer/spleeter/wiki/1.-Installation#using-conda),
with [pip](https://github.com/deezer/spleeter/wiki/1.-Installation#using-pip) or be used with
[Docker](https://github.com/deezer/spleeter/wiki/2.-Getting-started#using-docker-image).
-## Quick start
+## Quick start
-Want to try it out ? Just clone the repository and install a
-[Conda](https://github.com/deezer/spleeter/wiki/1.-Installation#using-conda)
-environment to start separating audio file as follows:
+Want to try it out but don't want to install anything ? We have setup a [Google Colab](https://colab.research.google.com/github/deezer/spleeter/blob/master/spleeter.ipynb).
+
+Ready to dig into it ? In a few lines you can install **Spleeter** using [Conda](https://github.com/deezer/spleeter/wiki/1.-Installation#using-conda) and separate the vocal and accompaniment parts from an example audio file:
+
+```bash
+# install using conda
+conda install -c conda-forge spleeter
+# download an example audio file
+wget https://github.com/deezer/spleeter/raw/master/audio_example.mp3
+# separate the example audio in two components
+spleeter separate -i audio_example.mp3 -p spleeter:2stems -o output
+```
+
+You should get two separated audio files (`vocals.wav` and `accompaniment.wav`) in the `output/audio_example` folder.
+
+For a detailed documentation, please check the [repository wiki](https://github.com/deezer/spleeter/wiki)
+
+## Development and testing
+
+The following set of commands will clone this repository, create a virtual environment provisioned with the dependencies and run the tests (will take a few minutes):
```bash
git clone https://github.com/Deezer/spleeter
-conda install -c conda-forge spleeter
-spleeter separate -i spleeter/audio_example.mp3 -p spleeter:2stems -o output
+python -m venv spleeterenv && source spleeterenv/bin/activate
+pip install -r requirements.txt && pip install pytest pytest-xdist
+make test
```
-You should get two separated audio files (`vocals.wav` and `accompaniment.wav`)
-in the `output/audio_example` folder.
-
-### Windows users
-
- It appears that sometimes the shortcut command `spleeter` does not work properly on windows. This is a known issue that we will hopefully fix soon. In the meantime replace `spleeter separate` by `python -m spleeter separate` in the above line and it should work.
-
-For a more detailed documentation, please check the [repository wiki](https://github.com/deezer/spleeter/wiki)
-
-Want to try it out but don't want to install anything ? we've setup a [Google Colab](https://colab.research.google.com/github/deezer/spleeter/blob/master/spleeter.ipynb)
## Reference
-
-- Deezer Research - Source Separation Engine Story - deezer.io blog post:
- * [English version](https://deezer.io/releasing-spleeter-deezer-r-d-source-separation-engine-2b88985e797e)
- * [Japanese version](http://dzr.fm/splitterjp)
-- [Music Source Separation tool with pre-trained models / ISMIR2019 extended abstract](http://archives.ismir.net/ismir2019/latebreaking/000036.pdf)
+* Deezer Research - Source Separation Engine Story - deezer.io blog post:
+ * [English version](https://deezer.io/releasing-spleeter-deezer-r-d-source-separation-engine-2b88985e797e)
+ * [Japanese version](http://dzr.fm/splitterjp)
+* [Music Source Separation tool with pre-trained models / ISMIR2019 extended abstract](http://archives.ismir.net/ismir2019/latebreaking/000036.pdf)
If you use **Spleeter** in your work, please cite:
@@ -66,13 +71,29 @@ If you use **Spleeter** in your work, please cite:
```
## License
+
The code of **Spleeter** is MIT-licensed.
## Disclaimer
+
If you plan to use Spleeter on copyrighted material, make sure you get proper authorization from right owners beforehand.
+## Troubleshooting
+
+**spleeter** is a complex piece of software and although we continously try to improve and test it you may encounter unexpected issues running it. If that's the case please check the [FAQ page](https://github.com/deezer/spleeter/wiki/5.-FAQ) first as well as the list of [currently open issues](https://github.com/deezer/spleeter/issues)
+
+### Windows users
+
+ It appears that sometimes the shortcut command `spleeter` does not work properly on windows. This is a known issue that we will hopefully fix soon. In the meantime replace `spleeter separate` by `python -m spleeter separate` in command line and it should work.
+
+
+## Contributing
+
+If you would like to participate in the development of **spleeter** your are more than welcome to do so. Don't hesitate to throw us a pull request and we'll do our best to examine it quickly.
+
## Note
+
This repository include a demo audio file `audio_example.mp3` which is an excerpt
from Slow Motion Dream by Steven M Bryant (c) copyright 2011 Licensed under a Creative
-Commons Attribution (3.0) license. http://dig.ccmixter.org/files/stevieb357/34740
+Commons Attribution (3.0) [license](http://dig.ccmixter.org/files/stevieb357/34740)
Ft: CSoul,Alex Beroza & Robert Siekawitch