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

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

Fixed spelling.

  • 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 760 2008-09-15 16:31:41Z 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{{{
34  svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.BaseFile/trunk se.lu.onk.BaseFile
35  cd se.lu.onk.BaseFile
36  ant
37}}}
38This will create a jar file `dist/basefile.jar`. If you want to change
39a released version you should replace `trunk` with `tags/release` in
40the above example.
41
42
43== Bug Reporting ==
44
45You can report `se.lu.onk.BaseFile` bugs on
46
47  http://baseplugins.thep.lu.se/newticket
48
49Use user `base` and password `base`.
50
51
52== Subversion Access ==
53
54The `se.lu.onk.BaseFile` source repository is available via anonymous
55subversion access, issue:
56
57  `svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.BaseFile/trunk se.lu.onk.BaseFile`
58
[760]59There is no guarantees about the contents or quality of the latest code
[758]60in the subversion repository: it is not unheard of for code that is
61known to be broken to be committed to the repository. Use at your own
[760]62risk. You may prefer to check out a released version instead.
[758]63
64
65----------------------------------------------------------------------
66{{{
67Copyright (C) 2008 Jari Häkkinen
68
69This file is part of the se.lu.onk.BaseFile package, a utility package
70for reading files generated by BASE. The package is available at
71http://baseplugins.thep.lu.se/ and BASE web site is
72http://base.thep.lu.se
73
74This is free software; you can redistribute it and/or modify it under
75the terms of the GNU General Public License as published by the Free
76Software Foundation; either version 3 of the License, or (at your
77option) any later version.
78
79This package is distributed in the hope that it will be useful, but
80WITHOUT ANY WARRANTY; without even the implied warranty of
81MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
82General Public License for more details.
83
84You should have received a copy of the GNU General Public License
85along with this package. If not, see <http://www.gnu.org/licenses/>.
86}}}
Note: See TracBrowser for help on using the repository browser.