source: plugins/base2/net.sf.basedb.illumina/trunk/COMPILE

Last change on this file was 2286, checked in by Nicklas Nordborg, 8 years ago

References #588: Update extensions to target Java 1.7 and BASE 3.3

Fixed README/INSTALL for Illumina package.

File size: 1.9 KB
Line 
1----------------------------------------------------------------------
2Instructions for compiling the
3Illumina plug-ins package for BASE.
4----------------------------------------------------------------------
5
6------------
7Requirements
8------------
9
101. Ant 1.8
11
122. Java 1.7
13
143. BASE 3.3.0
15
16---------
17Compiling
18---------
19
201. Type `ant download-lib` to automatically download the BASE core JAR file that
21   are neeed for compilation. You can also do this manually by copying the
22   base-core-3.x.jar, base-coreplugins-3.x.jar, base-webclient-3.x.jar and base-webservices-client-3.x.jar
23   files from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the ./lib/compile
24   directory.
25
262. Type `ant` to compile the code and put everything you need into
27   the ./dist directory.
28   
293. See the INSTALL file for installation instructions.
30
314. Use `ant package` to create a downloadable tar.gz package in the ./package
32   directory.
33
34----------
35Developers
36----------
37
38To make the development and testing of this plug-in easier do the following steps:
39
401. First time compilation and installation: Compile the source and
41   follow the instructions above and in the INSTALL and README files.
42   
43
442. Enabled the plug-in auto reload functionality in BASE by adding the following
45   configuration option to your base.config file:
46   
47   plugins.autounload = 1
48   
49   You may have to restart Tomcat after the change.
50   
51
523. Create a symbolic link from the BASE plug-ins directory to the JAR file in:
53
54   ./dist/illumina-plugins.jar
55
56
574. Now, when you change the code and re-compile it, BASE will
58   automatically detect the change and reload the new code the next
59   time you run the plug-in. There is no need to restart Tomcat or to
60   manually unload the old plug-in code. Note! The auto reload only works
61   for plug-ins. Extensions must be updated with the regular installation
62   procedure at Administrate -> Plug-ins & extensions -> Overview.
63   
64
65   
Note: See TracBrowser for help on using the repository browser.