updated README
authorPaul Brossier <piem@altern.org>
Sun, 6 Nov 2005 11:23:07 +0000 (11:23 +0000)
committerPaul Brossier <piem@altern.org>
Sun, 6 Nov 2005 11:23:07 +0000 (11:23 +0000)
updated README

python/README

index ce08675a7f0a1feba9ac87782cc224c67bccf370..b9b1c6c1510e0f27ec0fc97a6ae379d18a47e1b7 100644 (file)
@@ -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
+"""