source: plugins/base2/net.sf.basedb.examples/trunk/README @ 1292

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

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

Also removed calls to deprecated methods and tagger methods with @Override.

  • Property svn:mime-type set to text/x-trac-wiki
File size: 1.8 KB
RevLine 
[647]1== Requirements ==
2
[1292]3 1. BASE 2.17.0 or later.
[647]4 
5== Introduction ==
6
7This package contains some simple BASE plug-in examples. The target
8group is developers that want's to create their own BASE plug-ins.
9To install the plug-ins you need a local installation of BASE or
10administrator access to an existing BASE installation. We don't
11recommend that the example plug-ins are installed on a production
12server.
13
14Read http://base.thep.lu.se/chrome/site/latest/html/developerdoc/plugin_developer/plugin_developer.html
15for more information about developing BASE plug-ins.
16
17Currently, this package contains the following plug-ins:
18
19 * An importer that pretends to be able to import samples. It will
20   accept any file, but doesn't do anything. Main purpose is to
21   show parameter handling with plug-ins.
22 * An analyser plug-in that does some bogus calculations on a
23   bioassay set. Main purpose is to show how a plug-in can access
24   analysed data, do some calculations and store the result as
25   a new bioassay set.
26
27== Installation ==
28
29 1. Unpack the tar.gz file to a directory of your choice.
30 2. Copy the example-plugins.jar to your BASE plug-in directory.
31 3. Install the plug-ins using the BASE web interface. See
32    http://base.thep.lu.se/chrome/site/latest/html/admindoc/plugin_installation/plugins.installation.html
33    for more information.
34 4. Done.
35
36== Compiling ==
37
38To compile this package you also need:
39 
40 1. Ant 1.6
41 2. Java 1.6
42
43Follow these instructions:
44
[1291]45 1. Type 'ant download-lib' to download dependencies that are not included in
46    the subversion repository.
47   
48 2. Type 'ant' to compile the code and generate the 'example-plugins.jar' file
[647]49    in the project directory.
50
[1291]51 3. Use 'ant package' to create a downloadable tar.gz package in the project
[647]52    directory.
53
Note: See TracBrowser for help on using the repository browser.