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

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

Fixes #278: Plug-in should suggest better job names

File size: 1.8 KB
RevLine 
[546]1----------------------------------------------------------------------
2Instructions for compiling the
3Illumina plug-ins package for BASE.
4----------------------------------------------------------------------
5
6------------
7Requirements
8------------
9
101. Ant 1.6
11
122. Java 1.6
13
[1293]143. BASE 2.17.0
[546]15
16---------
17Compiling
18---------
19
[807]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
[1097]22   BASE2Core.jar, BASE2CorePlugins.jar, BASE2Webclient.jar and BASE2WSClient.jar files from the
[807]23   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
[546]27   the ./dist directory.
28   
[553]293. See the INSTALL file for installation instructions.
[546]30
[807]314. Use `ant package` to create a downloadable tar.gz package in the ./package
[585]32   directory.
33
[546]34----------
35Developers
36----------
37
38To make the development and testing of this plug-in easier do the following steps:
39
[685]401. First time compilation and installation: Compile the source and
41   follow the instructions above and in the INSTALL and README files.
[546]42   
[585]43
[546]442. Enabled the plug-in autoreload functionality in BASE by adding the following
45   configuration option to your base.config file:
46   
47   plugins.autounload = 1
48   
[585]49   You may have to restart Tomcat after the change.
50   
51
[546]523. Change the JAR path of the Illumina plug-ins to point to the JAR file in:
[585]53
[685]54   ./dist/illumina-plugins.jar
[585]55
[546]56   NOTE! You must of course enter the absolute path or BASE will not find the
57   plug-in.
58   
[585]59
[685]604. Now, when you change the code and re-compile it, BASE will
61   automatically detect the change and reload the new code the next
62   time you run the plug-in. There is no need to restart Tomcat or to
63   manually unload the old plug-in code.
Note: See TracBrowser for help on using the repository browser.