source: extensions/net.sf.basedb.reggie/trunk/README @ 1282

Last change on this file since 1282 was 1282, checked in by Nicklas Nordborg, 11 years ago

Initial checkin of main structure for Reggie. This compiles an extension package that installs a "Reggie" menu item in the "Extensions" menu.

File size: 1.7 KB
Line 
1== Requirements ==
2
3 1. BASE 2.16.0 or later.
4 
5== Introduction ==
6
7This package is an extension package to BASE that can be used to
8simplify biosource and sample registration.
9
10 * The homepage for this extension:
11   http://baseplugins.thep.lu.se/wiki/net.sf.basedb.reggie
12
13== Installation ==
14
15 1. Download the reggie-*.tar.gz file.
16 2. Unpack the downloaded file to a directory of your choice.
17 3. Copy the reggie.jar file to your BASE extensions directory:
18    WEB-INF/extensions.
19 4. Run the 'Extensions -> Manual scan' command if you have disabled automatic
20    installation. Otherwise, just wait a bit and the automatic installation will
21    find and install the new extension.
22 5. Done.
23 
24Reggie appears as a menu entry in the Extensions menu. All operations
25are available on that page.
26
27== Compiling ==
28
29To compile this package you also need:
30 
31 1. Ant 1.6
32 2. Java 1.6
33
34Follow these instructions:
35
36 1. Download the source code from the subversion repository. See
37    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.reggie for instructions.
38 
39 2. Type `ant download-lib` to automatically download the BASE core JAR files that
40    are neeed for compilation. You can also do this manually by copying the
41    BASE2Core.jar and BASE2Webclient.jar
42    from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the
43    ./lib/compile directory.
44
45 3. Type 'ant' to compile the code and generate the 'reggie.jar' file
46    in the project directory.
47
48 4. Use 'ant package' to create a downloadable tar.gz package.
49 
50Tip: If you need different values for any of the properties defined in
51the 'build.xml' file, create a file named 'build.properties' and set
52the values there.
53
Note: See TracBrowser for help on using the repository browser.