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

Last change on this file since 6541 was 785, checked in by Jari Häkkinen, 14 years ago

Removed trailing space character.

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