758 |
15 Sep 08 |
jari |
$Id$ |
758 |
15 Sep 08 |
jari |
2 |
|
758 |
15 Sep 08 |
jari |
= About `se.lu.onk.BaseFile` = |
758 |
15 Sep 08 |
jari |
4 |
|
758 |
15 Sep 08 |
jari |
The `se.lu.onk.BaseFile` package is a utility class used by many of |
758 |
15 Sep 08 |
jari |
the se.lu.onk plug-ins. Simply add the jar file supplied by this |
758 |
15 Sep 08 |
jari |
package to the classpath for the plug-in you want to run or |
758 |
15 Sep 08 |
jari |
compile. See specific plug-ins for further details on how to use this |
758 |
15 Sep 08 |
jari |
package. |
758 |
15 Sep 08 |
jari |
10 |
|
758 |
15 Sep 08 |
jari |
`se.lu.onk.BaseFile` is free software. See the file license.txt for |
758 |
15 Sep 08 |
jari |
copying conditions. |
758 |
15 Sep 08 |
jari |
13 |
|
758 |
15 Sep 08 |
jari |
The package was created by Johan Enell and is currently maintained by |
758 |
15 Sep 08 |
jari |
Jari Häkkinen. |
758 |
15 Sep 08 |
jari |
16 |
|
760 |
15 Sep 08 |
jari |
17 |
|
758 |
15 Sep 08 |
jari |
== Downloading == |
758 |
15 Sep 08 |
jari |
19 |
|
758 |
15 Sep 08 |
jari |
`se.lu.onk.BaseFile` can be obtained from |
758 |
15 Sep 08 |
jari |
21 |
|
758 |
15 Sep 08 |
jari |
http://baseplugins.thep.lu.se/wiki/PluginDownload |
758 |
15 Sep 08 |
jari |
23 |
|
758 |
15 Sep 08 |
jari |
24 |
|
758 |
15 Sep 08 |
jari |
== Installing and compiling == |
758 |
15 Sep 08 |
jari |
26 |
|
760 |
15 Sep 08 |
jari |
If you downloaded a binary package, read the instructions for the |
758 |
15 Sep 08 |
jari |
plug-in you are going to use together with this package. The plug-in |
758 |
15 Sep 08 |
jari |
instructions should explain how to use this package. |
758 |
15 Sep 08 |
jari |
30 |
|
758 |
15 Sep 08 |
jari |
If you want to modify and compile this package you must check it out |
758 |
15 Sep 08 |
jari |
from the repository, change to the package directory and issue `ant`; |
758 |
15 Sep 08 |
jari |
33 |
{{{ |
765 |
16 Sep 08 |
jari |
check out project, see instructions below |
765 |
16 Sep 08 |
jari |
# cd /path/to/se.lu.onk.BaseFile |
765 |
16 Sep 08 |
jari |
# ant |
758 |
15 Sep 08 |
jari |
37 |
}}} |
765 |
16 Sep 08 |
jari |
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 |
== Creating a distribution == |
770 |
18 Sep 08 |
jari |
42 |
|
775 |
18 Sep 08 |
jari |
Update the version number in `build.xml`, and issue `ant package`. This |
770 |
18 Sep 08 |
jari |
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 |
== Bug Reporting == |
758 |
15 Sep 08 |
jari |
48 |
|
785 |
18 Sep 08 |
jari |
You can report `se.lu.onk.BaseFile` bugs on |
758 |
15 Sep 08 |
jari |
50 |
|
758 |
15 Sep 08 |
jari |
http://baseplugins.thep.lu.se/newticket |
758 |
15 Sep 08 |
jari |
52 |
|
758 |
15 Sep 08 |
jari |
Use user `base` and password `base`. |
758 |
15 Sep 08 |
jari |
54 |
|
758 |
15 Sep 08 |
jari |
55 |
|
758 |
15 Sep 08 |
jari |
== Subversion Access == |
758 |
15 Sep 08 |
jari |
57 |
|
758 |
15 Sep 08 |
jari |
The `se.lu.onk.BaseFile` source repository is available via anonymous |
758 |
15 Sep 08 |
jari |
subversion access, issue: |
758 |
15 Sep 08 |
jari |
60 |
|
758 |
15 Sep 08 |
jari |
`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 |
There is no guarantees about the contents or quality of the latest |
765 |
16 Sep 08 |
jari |
code in the subversion repository: it is not unheard of for code that |
765 |
16 Sep 08 |
jari |
is known to be broken to be committed to the repository. Use at your |
765 |
16 Sep 08 |
jari |
own risk. You may prefer to check out a released version instead, then |
775 |
18 Sep 08 |
jari |
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 |
Copyright (C) 2008 Jari Häkkinen |
758 |
15 Sep 08 |
jari |
73 |
|
758 |
15 Sep 08 |
jari |
This file is part of the se.lu.onk.BaseFile package, a utility package |
758 |
15 Sep 08 |
jari |
for reading files generated by BASE. The package is available at |
758 |
15 Sep 08 |
jari |
http://baseplugins.thep.lu.se/ and BASE web site is |
758 |
15 Sep 08 |
jari |
http://base.thep.lu.se |
758 |
15 Sep 08 |
jari |
78 |
|
758 |
15 Sep 08 |
jari |
This is free software; you can redistribute it and/or modify it under |
758 |
15 Sep 08 |
jari |
the terms of the GNU General Public License as published by the Free |
758 |
15 Sep 08 |
jari |
Software Foundation; either version 3 of the License, or (at your |
758 |
15 Sep 08 |
jari |
option) any later version. |
758 |
15 Sep 08 |
jari |
83 |
|
758 |
15 Sep 08 |
jari |
This package is distributed in the hope that it will be useful, but |
758 |
15 Sep 08 |
jari |
WITHOUT ANY WARRANTY; without even the implied warranty of |
758 |
15 Sep 08 |
jari |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
758 |
15 Sep 08 |
jari |
General Public License for more details. |
758 |
15 Sep 08 |
jari |
88 |
|
758 |
15 Sep 08 |
jari |
You should have received a copy of the GNU General Public License |
758 |
15 Sep 08 |
jari |
along with this package. If not, see <http://www.gnu.org/licenses/>. |
758 |
15 Sep 08 |
jari |
91 |
}}} |