add a readme
[function2gene.git] / README
1 INSTALLATION 
2
3 Function2Gene currently requires the following:
4
5 perl
6 wget
7 HTML::TreeBuilder
8 HTML::ElementTable
9 XML::Parser::Expat
10 Thread::Queue
11
12 these requirements are most easily satisfied on a Debian system (or
13 other unix systems) but it is possible to use windows as well.
14
15 aptitude install wget perl libwww-perl libxml-parser-perl dh-make-perl;
16 dh-make-perl --cpan --build --install Thread::Queue;
17
18 will retrieve the necessary commponents. [On lenny or unstable, you
19 will want libhtml-parser-perl instead of libwww-perl.]
20
21 For other systems, installing the modules using CPAN may be the best
22 approach.
23
24 USAGE
25
26 All of the programs are located within a bin directory. For a
27 demonstration, you can simply do the following:
28
29 cd bin;
30 echo 'transferrin' > keywords.txt
31 function2gene --keywords keywords.txt --results keyword_results;
32