source: plugins/base1/se.lu.onk.BaseFile/trunk/README @ 775

$Id: README 775 2008-09-18 17:18:17Z jari $

= About `se.lu.onk.BaseFile` =

The `se.lu.onk.BaseFile` package is a utility class used by many of
the se.lu.onk 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.

`se.lu.onk.BaseFile` is free software. See the file license.txt for
copying conditions.

The package was created by Johan Enell and is currently maintained by
Jari Häkkinen.


== Downloading ==

`se.lu.onk.BaseFile` 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 `ant`;
{{{
  check out project, see instructions below
  # cd /path/to/se.lu.onk.BaseFile
  # ant
}}}
This will create a jar file `dist/BaseFile.jar`.


== Creating a distribution ==

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


== Bug Reporting ==

You can report `se.lu.onk.BaseFile` bugs on 

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

Use user `base` and password `base`.


== Subversion Access ==

The `se.lu.onk.BaseFile` source repository is available via anonymous
subversion access, issue:

  `svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.BaseFile/trunk se.lu.onk.BaseFile`

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 se.lu.onk.BaseFile package, a utility package
for reading files generated by BASE. 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/>.
}}}