add installation instructions

README.md

@@ -1,18 +1,43 @@
 # medley-de-bugger
 
-Hello! MedleyDeBugger is an app that processes your multitracks for error before they are uploaded to our awesome database!
+Hello! MedleyDeBugger is an GUI application that processes and error-checks multitracks before they are uploaded to the MedleyDB database.
 
-(see more at https://github.com/marl/medleydb)
+*Maintained by:*
 
-To use this app:
+Julia Wilkins @jlw365
 
-- Clone the repository to your local drive. 
-- Use the command line:
+Rachel Bittner @rabitt
 
-```cd medleydebugger/new_multitrack```  
 
-```python new_multitrack.py```   
+This code is released along with [MedleyDB](http://medleydb.weebly.com) and is a component of the work presented in the following publication:
 
+[R. Bittner](https://github.com/rabitt), [J. Wilkins](https://github.com/jlw365), [H. Yip](https://github.com/hmyip1) and J. P. Bello,
+"[MedleyDB 2.0: New Data and a System for Sustainable Data Collection](https://wp.nyu.edu/ismir2016/wp-content/uploads/sites/2294/2016/08/bittner-medleydb.pdf)", in
+Proceedings of the 17th International Society for Music Information Retrieval Conference Late Breaking and Demo Papers,
+New York City, USA, Aug. 2016.
+
+
+Related Projects
+----------------
+MedleyDB [[code repository]](https://github.com/marl/medleydb) [[website]](http://medleydb.weebly.com)
+
+[MedleyDB Manager](https://github.com/marl/medleydb_manager)
+
+
+Installation (via Homebrew)
+---------------------------
+- `git clone https://github.com/marl/medley-de-bugger.git`
+- `cd medley-de-bugger`
+- `pip install -r requirements.txt`
+- `brew install sox`
+- `brew install qt`
+- `brew install sip`
+- `brew install pyqt`
+
+Usage
+-----
+`# launch the application`
+`python new_multitrack/new_multitrack.py` 
 
 - Follow the prompts to select your audio and run it through the app.
-- After you're done, a new folder should be generated with your corrected audio and the correct naming format. Complete!
+- After you're done, a new folder will be generated with a multitrack in MedleyDB format.

requirements.txt

@@ -0,0 +1,3 @@
+sox>=1.2.1
+git+git://github.com/marl/medleydb.git
+numpy>=1.11.0

setup.py

@@ -12,18 +12,17 @@
 DATA_FILES = ['new_multitrack/taxonomy.yaml', 'homer.icns']
 OPTIONS = {'argv_emulation': True,
     'iconfile': 'homer.icns',
-	'includes': ['glob', 'PyQt4', 'sys', 'os', 'yaml', 'functools', 'medleydb',
-				 'copy', 're', 'struct','wave']}
+	'includes': ['PyQt4', 'medleydb', 're']}
 
 setup(
-    name = "new_multitrack",
-    description = "app for processing multitracks in medleydb format",
-    url = "https://github.com/marl/medleydb_app",
-	packages = ['new_multitrack'],
-	package_data = {'new_multitrack': DATA_FILES},
+    name="new_multitrack",
+    description="app for processing multitracks in medleydb format",
+    url="https://github.com/marl/medleydb_app",
+    packages=['new_multitrack'],
+    package_data={'new_multitrack': DATA_FILES},
     app=APP,
     data_files=DATA_FILES,
     options={'py2app': OPTIONS},
     setup_requires=['py2app'],
-    install_requires =['pyyaml', 'sox', 'numpy']
+    install_requires=['pyyaml', 'sox', 'numpy']
 )