plugins/base2/net.sf.basedb.pluginutilities/trunk/README

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

Generated on Tue Nov 21 03:43:58 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)