Skip to content
Knickedi edited this page Oct 21, 2011 · 9 revisions

The tools are designed as library projects.

  • First option is to simply include the whole project and use it. That's the most safest way because you will benefit from future bugfixes and haven't to deal with anything else. The downside is that you're including all classes and won't even use some of them.
  • Second option is the same as first but you can simply delete unneeded classes before compiling. This way you can still update the project easily. You have to take care of class dependencies, they are documented at the bottom of every class javadoc.
  • Third option is drastic. Take the classes from the project and include them in your own project. Take care of dependencies (see second option). This way would update the classes if you want to benefit from future update.
  • ... just suggestions. You can do whatever you want. Maybe pull the project and include the classes manually in your build path ...

I will introduce a class documentation tag (in the title of each class) which will indicate the stability of a tool so you can have some expectations and state information when using it:

  • A - class is still under development and probably will cause problems - not recommended for release use - use it if really like the idea and want to help improving it
  • B - class is finished so far an passed some plausible tests - be prepared to face problems and please report them if you use it
  • C - class is used by myself and all teething troubles should be fixed - this is pretty stable - there still might be some errors on other platforms, please report them
  • D - class is used by other people and the started to report problems on other platforms - a class in this state will be (at least almost) final
Clone this wiki locally