add a readme

[function2gene.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..d58ea51
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+INSTALLATION 
+
+Function2Gene currently requires the following:
+
+perl
+wget
+HTML::TreeBuilder
+HTML::ElementTable
+XML::Parser::Expat
+Thread::Queue
+
+these requirements are most easily satisfied on a Debian system (or
+other unix systems) but it is possible to use windows as well.
+
+aptitude install wget perl libwww-perl libxml-parser-perl dh-make-perl;
+dh-make-perl --cpan --build --install Thread::Queue;
+
+will retrieve the necessary commponents. [On lenny or unstable, you
+will want libhtml-parser-perl instead of libwww-perl.]
+
+For other systems, installing the modules using CPAN may be the best
+approach.
+
+USAGE
+
+All of the programs are located within a bin directory. For a
+demonstration, you can simply do the following:
+
+cd bin;
+echo 'transferrin' > keywords.txt
+function2gene --keywords keywords.txt --results keyword_results;
+