plugins/base1/se.lu.onk.BaseFile/trunk/README

Code
Comments
Other
Rev Date Author Line
758 15 Sep 08 jari 1 $Id$
758 15 Sep 08 jari 2
758 15 Sep 08 jari 3 = About `se.lu.onk.BaseFile` =
758 15 Sep 08 jari 4
758 15 Sep 08 jari 5 The `se.lu.onk.BaseFile` package is a utility class used by many of
758 15 Sep 08 jari 6 the se.lu.onk plug-ins. Simply add the jar file supplied by this
758 15 Sep 08 jari 7 package to the classpath for the plug-in you want to run or
758 15 Sep 08 jari 8 compile. See specific plug-ins for further details on how to use this
758 15 Sep 08 jari 9 package.
758 15 Sep 08 jari 10
758 15 Sep 08 jari 11 `se.lu.onk.BaseFile` is free software. See the file license.txt for
758 15 Sep 08 jari 12 copying conditions.
758 15 Sep 08 jari 13
758 15 Sep 08 jari 14 The package was created by Johan Enell and is currently maintained by
758 15 Sep 08 jari 15 Jari Häkkinen.
758 15 Sep 08 jari 16
760 15 Sep 08 jari 17
758 15 Sep 08 jari 18 == Downloading ==
758 15 Sep 08 jari 19
758 15 Sep 08 jari 20 `se.lu.onk.BaseFile` can be obtained from
758 15 Sep 08 jari 21
758 15 Sep 08 jari 22   http://baseplugins.thep.lu.se/wiki/PluginDownload
758 15 Sep 08 jari 23
758 15 Sep 08 jari 24
758 15 Sep 08 jari 25 == Installing and compiling ==
758 15 Sep 08 jari 26
760 15 Sep 08 jari 27 If you downloaded a binary package, read the instructions for the
758 15 Sep 08 jari 28 plug-in you are going to use together with this package. The plug-in
758 15 Sep 08 jari 29 instructions should explain how to use this package.
758 15 Sep 08 jari 30
758 15 Sep 08 jari 31 If you want to modify and compile this package you must check it out
758 15 Sep 08 jari 32 from the repository, change to the package directory and issue `ant`;
758 15 Sep 08 jari 33 {{{
765 16 Sep 08 jari 34   check out project, see instructions below
765 16 Sep 08 jari 35   # cd /path/to/se.lu.onk.BaseFile
765 16 Sep 08 jari 36   # ant
758 15 Sep 08 jari 37 }}}
765 16 Sep 08 jari 38 This will create a jar file `dist/BaseFile.jar`.
758 15 Sep 08 jari 39
758 15 Sep 08 jari 40
770 18 Sep 08 jari 41 == Creating a distribution ==
770 18 Sep 08 jari 42
775 18 Sep 08 jari 43 Update the version number in `build.xml`, and issue `ant package`. This
770 18 Sep 08 jari 44 creates a distribution package with all required components.
770 18 Sep 08 jari 45
770 18 Sep 08 jari 46
758 15 Sep 08 jari 47 == Bug Reporting ==
758 15 Sep 08 jari 48
785 18 Sep 08 jari 49 You can report `se.lu.onk.BaseFile` bugs on
758 15 Sep 08 jari 50
758 15 Sep 08 jari 51   http://baseplugins.thep.lu.se/newticket
758 15 Sep 08 jari 52
758 15 Sep 08 jari 53 Use user `base` and password `base`.
758 15 Sep 08 jari 54
758 15 Sep 08 jari 55
758 15 Sep 08 jari 56 == Subversion Access ==
758 15 Sep 08 jari 57
758 15 Sep 08 jari 58 The `se.lu.onk.BaseFile` source repository is available via anonymous
758 15 Sep 08 jari 59 subversion access, issue:
758 15 Sep 08 jari 60
758 15 Sep 08 jari 61   `svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.BaseFile/trunk se.lu.onk.BaseFile`
758 15 Sep 08 jari 62
765 16 Sep 08 jari 63 There is no guarantees about the contents or quality of the latest
765 16 Sep 08 jari 64 code in the subversion repository: it is not unheard of for code that
765 16 Sep 08 jari 65 is known to be broken to be committed to the repository. Use at your
765 16 Sep 08 jari 66 own risk. You may prefer to check out a released version instead, then
775 18 Sep 08 jari 67 replace `trunk` with `tags/version` in the above example.
758 15 Sep 08 jari 68
758 15 Sep 08 jari 69
758 15 Sep 08 jari 70 ----------------------------------------------------------------------
758 15 Sep 08 jari 71 {{{
758 15 Sep 08 jari 72 Copyright (C) 2008 Jari Häkkinen
758 15 Sep 08 jari 73
758 15 Sep 08 jari 74 This file is part of the se.lu.onk.BaseFile package, a utility package
758 15 Sep 08 jari 75 for reading files generated by BASE. The package is available at
758 15 Sep 08 jari 76 http://baseplugins.thep.lu.se/ and BASE web site is
758 15 Sep 08 jari 77 http://base.thep.lu.se
758 15 Sep 08 jari 78
758 15 Sep 08 jari 79 This is free software; you can redistribute it and/or modify it under
758 15 Sep 08 jari 80 the terms of the GNU General Public License as published by the Free
758 15 Sep 08 jari 81 Software Foundation; either version 3 of the License, or (at your
758 15 Sep 08 jari 82 option) any later version.
758 15 Sep 08 jari 83
758 15 Sep 08 jari 84 This package is distributed in the hope that it will be useful, but
758 15 Sep 08 jari 85 WITHOUT ANY WARRANTY; without even the implied warranty of
758 15 Sep 08 jari 86 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
758 15 Sep 08 jari 87 General Public License for more details.
758 15 Sep 08 jari 88
758 15 Sep 08 jari 89 You should have received a copy of the GNU General Public License
758 15 Sep 08 jari 90 along with this package. If not, see <http://www.gnu.org/licenses/>.
758 15 Sep 08 jari 91 }}}