66eaf1d42ec7abaf3b0dd54d0d4143965b04d607 max Fri Sep 4 00:13:37 2015 -0700 adding link to mirror instructions refs #15969 diff --git README README index 8a2d088..1e54e87 100644 --- README +++ README @@ -1,28 +1,35 @@ CONTENTS AND COPYRIGHT This directory contains the entire source tree for the UCSC Genome Bioinformatics Group's suite of biological analysis and web display programs as well as some of Jim Kent's own tools. All files are copyrighted, but license is hereby granted for personal, academic, and non-profit use. A license is also granted for the contents of the src/lib, src/inc and src/utils and python directories for commercial users. Commercial users should contact kent@soe.ucsc.edu for access to other modules. Commercial users interested in the UCSC Genome Browser in particular please see http://genome.ucsc.edu/license/. +If you want to run a local installation of the UCSC Genome Browser +(we call this a mirror, even when it includes only a small +part of the data), you do not need the whole source tree. We provide +statically compiled binary CGI-bin executables, the apache htdocs folder, +binary MySQL databases and ancillary large data files in /gbdb via an Rsync +download server. For install details see http://genome.ucsc.edu/admin/mirror.html + Most source code users will only be interested in the src/inc and src/lib directories, which contain the interfaces and implementations to the library routines, and in a few specific applications. The applications are scattered in other directories. Many of them are web based. The UCSC Genome Browser in particular is mostly found in src/hg/hgTracks. GENERAL INSTALL INSTRUCTIONS 1. Get the code. The best way to do this now for Unix users is via Git following the instructions at: http://genome.ucsc.edu/admin/git.html Or, fetch the entire source in a single file: http://hgdownload.cse.ucsc.edu/admin/jksrc.zip Note further documentation for the build process in your unpacked source tree in src/product/README.*