README

   1 Jalview README
   2 ==============
   3
   4 Welcome !
   5
   6 Jalview is free (GPLv3 licensed) software for creation, interactive
   7 visualisation and analysis of alignments of biological sequences. It
   8 was developed by Michele Clamp in 1996, and now maintained by the
   9 Jalview Development team in the Barton group at the University of
  10 Dundee.
  11
  12 If you'd like to help out please check out the website
  13 (www.jalview.org) and get in touch. See CITATION for the canonical
  14 reference if you need to cite Jalview.
  15
  16 To build the Jalview Desktop application and JalviewJS, the JavaScript
  17 transpiled version (with the help of java2script, courtesy of Bob
  18 Hanson), you will need a Java 11 JDK and a recent version of
  19 Gradle. For development we recommend Eclipse - you should be able to
  20 import Jalview as a Gradle project with the Buildship plugin.
  21
  22 Most likely you'll want to take a look at doc/building.md to find out
  23 exactly what is needed. If you already have Java 11 and Gradle, then
  24 the tldr:
  25
  26 gradle test # run functional test suite
  27
  28 gradle shadowJar # build a single executable Jar under build/libs/
  29
  30 gradle jalviewjs # builds JalviewJS under build/jalviewjs
  31
  32 If you want to build JalviewJS then you will also need to download
  33 Eclipse for your platform, since transpilation requires an Eclipse
  34 plugin.