summarylogtreecommitdiffstats
path: root/transabyss.install
diff options
context:
space:
mode:
Diffstat (limited to 'transabyss.install')
-rw-r--r--transabyss.install35
1 files changed, 35 insertions, 0 deletions
diff --git a/transabyss.install b/transabyss.install
new file mode 100644
index 000000000000..d65d553051b1
--- /dev/null
+++ b/transabyss.install
@@ -0,0 +1,35 @@
+post_install() { cat << EOF
+
+Configuration
+-------------
+
+Configuration files are saved in:
+
+ /etc/transabyss
+
+You will most likely want to edit the genomes section transcriptome.cfg to point
+to the location of your genomes.
+
+Preparing Genomes
+-----------------
+
+The genomes are usually created by downloading a reference genome,
+e.g. [hg19][1], and running gmap_build, see [gmap README][2]:
+
+ gmap_build -g -d hg19 -D /path/to/genomes chr22.fa.gz
+
+[1]: ftp://hgdownload.cse.ucsc.edu/goldenPath/hg19/chromosomes/
+[2]: http://research-pub.gene.com/gmap/src/README
+
+Getting Started
+---------------
+
+transabyss installs an /etc/profile.d/transabyss.sh script that you either need
+to source right now or restart your shell session.
+
+EOF
+}
+
+post_upgrade() {
+ post_install
+}