================================================================================
                                                                                
                ÛÛÛÛÛÛÛÛÛÛÛÛ               ÛÛÛÛÛ                 ÛÛÛÛÛÛ         
             ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ           ÛÛÛÛÛÛÛ               ÛÛÛÛÛÛÛÛ        
           ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ         ÛÛÛÛÛÛÛÛÛ             ÛÛÛÛÛÛÛÛÛÛ       
          ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ       ÛÛÛÛÛÛÛÛÛÛ             ÛÛÛÛÛÛ²²²²       
         ÛÛÛÛÛÛÛÛÛ²²²²²²²²²²²²²ÛÛÛÛ     ÛÛÛÛÛ²²²²²²             ÛÛÛ²²²²²        
        ÛÛÛÛÛÛÛ²²²²²²²²²²²²²²²²²²²²²     ÛÛÛ²²²²²²²              ²²²²²²         
       ÛÛÛÛÛÛ²²²²²²²²²²²²²²²²²²²²²²²²    ÛÛÛ²²²²²²²                             
       ÛÛÛÛÛ²²²²²²       ²²²²²²²²²²²²    ÛÛÛ²²²²²²²²²                           
      ÛÛÛÛÛ²²²²²           ²²²²²²²²²²²    ÛÛ²²²²²²²²²ÛÛÛÛÛÛÛÛÛÛÛ                
      ÛÛÛÛ²²²²²             ²²²²²²²²²²     Û²²²²²²²²²²ÛÛÛÛÛÛÛÛÛÛÛÛ              
      ÛÛÛ²²²²²²             ÛÛ²²²²²²²²       ²²²²²²²²²²²²ÛÛÛÛÛÛÛÛÛÛ             
      ÛÛÛ²²²²²²             ÛÛÛ²²²²²²²        ²²²²²²²²²²²²²²²²²ÛÛÛÛÛÛ           
      ÛÛÛ²²²²²²             ÛÛÛ²²²²²²²          ²²²²²²²²²²²²²²²²²²²ÛÛÛ          
      ÛÛÛ²²²²²²²            ÛÛÛ²²²²²²²             ²²²²²²²²²²²²²²²²²²ÛÛ         
      ÛÛÛ²²²²²²²²           ÛÛÛ²²²²²²²                      ²²²²²²²²²²Û         
       ÛÛ²²²²²²²²ÛÛÛÛÛÛÛ    ÛÛ²²²²²²²²    ÛÛÛÛÛÛ              ²²²²²²²²²²        
        Û²²²²²²²²²ÛÛÛÛÛÛÛ   ÛÛ²²²²²²²²   ÛÛÛÛÛÛÛÛ              ²²²²²²²²²        
          ²²²²²²²²²²²ÛÛÛÛÛ  ÛÛ²²²²²²²²  ÛÛÛÛÛÛÛÛÛÛ             Û²²²²²²²²        
           ²²²²²²²²²²²²²²²  ÛÛ²²²²²²²²  ÛÛÛÛÛÛ²²²²             ÛÛ²²²²²²²        
            ²²²²²²²²²²²²²   ÛÛ²²²²²²²    ÛÛÛ²²²²²              ÛÛÛ²²²²²²        
              ²²²²²²²²²²     ²²²²²²²      ²²²²²²                ÛÛ²²²²²         
                                                                                
[axonlib v.0.1.2-pre]
================================================================================

README

[*] project home
http://axonlib.googlecode.com

[*] licensing agreement:
docs/PREAMBLE, docs/LICENSE_AX

[*] building the doxygen documentation
install doxygen and use docs/makedocs(.cmd) with doxygen.cfg to
generate the documentation in the docs folder.

[*] build requirements 
  - linux
    gcc, g++, xorg-dev 
  - windows
    mingw (official) or mingw-gcc-tdm

for vst plugins you will need the vst sdk 2.4.
place it in a folder outside of the axonlib folder (where this README is).
  
[*] getting started
look in the folder source/test/ for some examples
to compile use the compile scripts compile (linux bash)
and compile.cmd (windows)

to compile an executable:
  ./compile ./test/test_gain_gui.cpp -exe
to compile a vst plugin:
  cd source
  ./compile ./test/test_gain_gui.cpp -vst

the resulting binary will be moved to axonlib/bin.
see ./compile -h for more command line options

[*] user notes
docs/USER

[*] developer notes
docs/DEV

[*] authors
docs/AUTHORS

[*] todo list
docs/TODO

================================================================================