===========
License
===========


The MIT License

Copyright 2015 Hilmar.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.







=======================
Third party libraries
=======================

GenLib uses the JFreeChart-Library and JCommons. They are both under GNU LGPL
license. The versions I currently use GenLib with are as *.jar in the lib
directory. More informations: http://www.jfree.org/




===========
First steps
===========

There is an example-viewer included, so just start the GenLib.jar. I would
recommend it to start in the console, so you don't miss the text-output.
For examples, using the GenLib-functionality, see: src/genlib/examples/

The library is currently under heavy development, so currently, there is no
good documentation available. Please have a look at the javadoc annotations.

Editing is restricted for collaborators only, so if you are interested in
collaborating, please contact me via git-hub:
https://github.com/hackermann/GenLib

If you want to use a Netbeans "build.xml", just rename the "netbeans_build.xml"
to "build.xml". This build-script builds additionaly a java-doc jar and does
at the end the lib-completeness-test.