Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinso committed Dec 5, 2023
1 parent 5468e10 commit b7b2460
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions scripts/readme.txt
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
=======================
IGV BINARY DISTRIBUTION
IGV DISTRIBUTION
=======================

Prerequisites:

Java 11 (http://openjdk.java.net). Not compatible with Java 8, 9, 10. We do not test
on Java releases > 11 and cannot vouch for the behavior.
Java 17 or greater is required. A free open source distributions of Java is available at https://adoptium.net/.

Java 11 is bundled with our "Java included" distributions.

For our other "separate Java 11 required" distributions, Java 11 must be installed and made
available as the default. These bundles are recommended only for those users that wish to
manage Java for themselves.

Note that we provide both a Mac App and a Windows installer for users on those platforms that
want a more standard way to launch.

Instructions:
-------------

1. Download and unzip the distribution file to a directory of your choice.

Expand All @@ -31,6 +23,10 @@ igv.command (for macOS, double-click to start)
Some of these may not be present depending on the distribution you downloaded. You might have to
make the script executable (e.g. chmod a+x igv.sh) depending on the way the bundle was unpacked.


Advanced options follow -- these are not common:
------------------------------------------------

The bat and shell scripts are configured to start IGV with 4GB of memory. This is a
reasonable default for most machines but if you are working with very large datasets
you can override this setting (and other Java-related defaults) by editing IGV's
Expand Down

0 comments on commit b7b2460

Please sign in to comment.