Added quickstart

This commit is contained in:
Will Drevo 2014-12-15 21:35:47 -05:00
parent 19679f8d11
commit 83fb7042ad
2 changed files with 14 additions and 6 deletions

View file

@ -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 * [`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 * [`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+ ### Dependency installation on Fedora 20+
Install the dependencies Install the dependencies:
sudo yum install numpy scipy python-matplotlib ffmpeg portaudio-devel sudo yum install numpy scipy python-matplotlib ffmpeg portaudio-devel
pip install PyAudio pip install PyAudio
pip install pydub 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 pip install virtualenv
virtualenv --system-site-packages env_with_system virtualenv --system-site-packages env_with_system
Install from PyPI Install from PyPI:
source env_with_system/bin/activate source env_with_system/bin/activate
pip install PyDejavu pip install PyDejavu
@ -36,7 +36,7 @@ Install from PyPI
You can also install the latest code from GitHub: You can also install the latest code from GitHub:
source env_with_system/bin/activate 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 ## Max OS X

View file

@ -10,6 +10,14 @@ Dejavu can memorize audio by listening to it once and fingerprinting it. Then by
Read [INSTALLATION.md](INSTALLATION.md) Read [INSTALLATION.md](INSTALLATION.md)
## Quickstart
```bash
$ git clone https://github.com/worldveil/dejavu.git ./dejavu
$ cd dejavu
$ python example.py
```
## Setup ## Setup
First, install the above dependencies. First, install the above dependencies.