$Id: README 847 2008-12-01 19:10:33Z jari $

About PluginUtilities?

The PluginUtilities? (net.sf.basedb.pluginutilities) package is a utility class package for use when creating BASE plug-ins. The aim is to simplify creation of BASE plug-ins. Simply add the jar file supplied by this package to the classpath for the plug-in you want to run or compile. See specific plug-ins for further details on how to use this package.

PluginUtilities? is free software. See the file license.txt for copying conditions.

The package was created, and is currently maintained, Jari Häkkinen.

Downloading

PluginUtilities? can be obtained from

​http://baseplugins.thep.lu.se/wiki/PluginDownload

Installing and compiling

If you downloaded a binary package, read the instructions for the plug-in you are going to use together with this package. The plug-in instructions should explain how to use this package.

If you want to modify and compile this package you must check it out from the repository, change to the package directory and issue a couple of ant commands:

  check out project, see instructions below
  # cd /path/to/PluginUtilities
  # ant download-lib
  # ant

This will create a jar file dist/AbstractRunBinary.jar.

Creating a distribution

Update the version number in build.xml, and issue `ant download-lib ; ant package`. This creates a distribution package with all required components.

Bug Reporting

You can report PluginUtilities? bugs on

​http://baseplugins.thep.lu.se/newticket

Use user base and password base.

Subversion Access

The PluginUtilities? source repository is available via anonymous subversion access. For the latest maybe unstable version issue:

svn co http://baseplugins.thep.lu.se/svn/plugins/base2/net.sf.basedb.pluginutilities/trunk net.sf.basedb.pluginutilities

There is no guarantees about the contents or quality of the latest code in the subversion repository: it is not unheard of for code that is known to be broken to be committed to the repository. Use at your own risk. You may prefer to check out a released version instead, then replace trunk with tags/version in the above example.

Copyright (C) 2008 Jari Häkkinen
This file is part of the net.sf.basedb.pluginutilities package, a
utility package that simplifies creation of BASE plug-ins. The package
is available at http://baseplugins.thep.lu.se/ and BASE web site is
http://base.thep.lu.se
This is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your
option) any later version.
This package is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this package. If not, see <http://www.gnu.org/licenses/>.