diff --git a/INSTALLATION.md b/INSTALLATION.md index df75562..34161ac 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -1,6 +1,6 @@ -# Installation of dejavu +# Installation of Dejavu -So far dejavu has only been tested on Unix systems. +So far Dejavu has only been tested on Unix systems. * [`pyaudio`](http://people.csail.mit.edu/hubert/pyaudio/) for grabbing audio from microphone * [`ffmpeg`](https://github.com/FFmpeg/FFmpeg) for converting audio files to .wav format @@ -16,18 +16,18 @@ For installing `ffmpeg` on Mac OS X, I highly recommend [this post](http://junge ### Dependency installation on Fedora 20+ -Install the dependencies +Install the dependencies: sudo yum install numpy scipy python-matplotlib ffmpeg portaudio-devel pip install PyAudio pip install pydub -Now setup virtualenv ([howto?](http://www.pythoncentral.io/how-to-install-virtualenv-python/)) +Now setup virtualenv ([howto?](http://www.pythoncentral.io/how-to-install-virtualenv-python/)): pip install virtualenv virtualenv --system-site-packages env_with_system -Install from PyPI +Install from PyPI: source env_with_system/bin/activate pip install PyDejavu @@ -36,7 +36,7 @@ Install from PyPI You can also install the latest code from GitHub: source env_with_system/bin/activate - pip install https://github.com/tuxdna/dejavu/zipball/master + pip install https://github.com/worldveil/dejavu/zipball/master ## Max OS X diff --git a/README.md b/README.md index 5da9602..d5d3e54 100755 --- a/README.md +++ b/README.md @@ -10,6 +10,14 @@ Dejavu can memorize audio by listening to it once and fingerprinting it. Then by Read [INSTALLATION.md](INSTALLATION.md) +## Quickstart + +```bash +$ git clone https://github.com/worldveil/dejavu.git ./dejavu +$ cd dejavu +$ python example.py +``` + ## Setup First, install the above dependencies.