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

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

References #292: Check/create annotation types, etc. required by reggie

This should now work with the items that we need so far for the personal information registration wizard.

File size: 1.9 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. Log in as a user with Administrator priviliges. Go to the Extensions -> Reggie
23    menu. Select the 'Verify/install required annotation types and other items'
24    wizard and create the required items.
25 6. Done.
26 
27Reggie appears as a menu entry in the Extensions menu. All operations
28are available on that page.
29
30== Compiling ==
31
32To compile this package you also need:
33 
34 1. Ant 1.6
35 2. Java 1.6
36
37Follow these instructions:
38
39 1. Download the source code from the subversion repository. See
40    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.reggie for instructions.
41 
42 2. Type `ant download-lib` to automatically download the BASE core JAR files that
43    are neeed for compilation. You can also do this manually by copying the
44    BASE2Core.jar and BASE2Webclient.jar
45    from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the
46    ./lib/compile directory.
47
48 3. Type 'ant' to compile the code and generate the 'reggie.jar' file
49    in the project directory.
50
51 4. Use 'ant package' to create a downloadable tar.gz package.
52 
53Tip: If you need different values for any of the properties defined in
54the 'build.xml' file, create a file named 'build.properties' and set
55the values there.
56
Note: See TracBrowser for help on using the repository browser.