Mercurial > hg > auditok
diff README.md @ 40:23dbe3bacdf7
doc update
author | Amine Sehili <amine.sehili@gmail.com> |
---|---|
date | Thu, 03 Dec 2015 01:21:44 +0100 |
parents | c964768a000a |
children | ee6c9924df75 |
line wrap: on
line diff
--- a/README.md Thu Dec 03 01:10:21 2015 +0100 +++ b/README.md Thu Dec 03 01:21:44 2015 +0100 @@ -41,17 +41,21 @@ Requirements ------------ -`auditok` can be used with standard Python! -However if you want more features, the following packages are needed: +`auditok` can be used with standard Python! + +However, if you want more features, the following packages are needed: - [pydub](https://github.com/jiaaro/pydub): read audio files of popular audio formats (ogg, mp3, etc.) or extract audio from a video file - [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/): read audio data from the microphone and play back detections -- `matplotlib`: plot audio signal and detections (see figures above) -- `numpy`: required by matplotlib. Also used for math operations instead of standard python if available +- [matplotlib](http://matplotlib.org/): plot audio signal and detections (see figures above) +- [numpy](http://www.numpy.org): required by matplotlib. Also used for math operations instead of standard python if available - Optionnaly, you can use `sox` or `parecord` for data acquisition and feed `auditok` using a pipe. Installation ------------ + + git clone https://github.com/amsehili/auditok.git + cd auditok python setup.py install Command line usage