From: Paul Brossier <piem@altern.org>
Date: Sun, 6 Nov 2005 11:23:07 +0000 (+0000)
Subject: updated README
X-Git-Tag: bzr2git~818
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=197571a68720b9cceafb22353d2bb6a654ed2a4a;p=aubio.git

updated README
updated README
---

diff --git a/python/README b/python/README
index ce08675a..b9b1c6c1 100644
--- a/python/README
+++ b/python/README
@@ -3,6 +3,27 @@
 
 # To have it working before installation, you will need to set LD_LIBRARY_PATH.
 # for instance, to run the python script from within aubio/python/, you can use
-# 'source ./README'
+# '. README'
 
 export LD_LIBRARY_PATH=../src/.libs:../ext/.libs
+
+echo """
+
+the aubio/ directory should be organised as follow:
+
+ aubiowrapper.py,_aubiowrapper.so, aubio_wrap.c, aubio_wrap.o
+ 	swig generated aubio interface 
+ aubioclass.py
+ 	human usable interface
+ plot/
+ 	everything required to plot
+ web/
+ 	tools to use aubioweb.py
+ bench/
+ 	tools to explore a database of sound file and run benchmarks on it
+ eval/
+ 	tools to evaluate the performance of aubio extractors
+ aubioweb.py
+ 	a hack to pipe aubio in mod_python
+ 
+"""