Read Me

Algomusic-a Java toolkit for algorithmic music generation
Originally by Miguel Haruki Yamaguchi

Email: haruki.yamaguchi1989@gmail.com
Website: http://cs.lafayette.edu/~yamagucm

***********************************************************

Sections of the README: 

1-About Algomusic
2-Developer's Note (Help is needed!)
3-Usage

1) About Algomusic
***********************************************************

This is a 'placeholder' README. I have a PDF I made which explains
the code better. As this project is just getting started, I will be 
writing some documentation and commenting code in the next few weeks.

Algomusic is a set of Java classes which is intended for customizable
production of algorithmic music (Music produced by algorithms.) 
It uses the jMusic API as the layer abstracting the MIDI and data structure
logic. 

Algomusic was started in February 2010 and developed over two months as a 
college project before becoming an open source project.

Algomusic is intended to become a tool, and hopefully a GUI application,
that can demonstrate the power of algorithmic music composition and 
hopefully be used for educational purposes. For this reason it's very 
experimental and creative/artistic.

Currently, the software consists of several "Generators" which produce 
algorithmic music, most of them getting input from text-files. If you 
want to hear some examples, please email me, my email is listed below.

2) Developer's Note
********************

Please feel free to join the project if you are interested in Java and 
these kinds of creative/artistic tools.

To contribute, you will need to register yourself on SourceForge, it's free. 

The project page is at 
http://sourceforge.net/projects/algomusic/

I can be contacted via email (haruki.yamaguchi1989@gmail.com)
or by messaging (https://sourceforge.net/sendmessage.php?touser=2977389)

*** Currently I need help in ***

1) Creation of new algorithms and building upon current algorithms for 
much greater musical expression and variety

2) Initiation of GUI (graphical interface)
3) Cleaning code, Testing and Debugging
4) Documentation (Not too much now, until more classes are added)

Of course, anything from bug reports, testing, and full-blown development is welcome!

3) USAGE
**********************

Algomusic can be used like any Java API (it's a very small one though :))
Just include this in the build path and it should work. 

For an idea of how to use, look at the Tester files, in src/net/sourceforge/algomusic/testing.

Make sure you also include the JAR files in lib/ (the classes depend on these 
libraries).