JAL-4046 release notes for JAL-4014 - gecos colourschemes

[jalview.git] / README

diff --git a/README b/README
old mode 100755 (executable)
new mode 100644 (file)
index 618a615..5735c8e
--- a/README
+++ b/README
@@ -1,33 +1,34 @@
-Jalview Readme\r
---------------\r
-\r
-\r
-The source is available as a tar file and comes complete with the GNU General Public License. \r
-\r
-To build the application you will need a J2SDK 1.4+. \r
-\r
-An Ant build file (build.xml) is provided, you will need to install Apache Ant first. Run ant to build the application, use the target "makeApplet" to make the Applet.\r
-\r
-You can also use Borland JBuilder to build Jalview. A JBuilder project file (JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided.\r
-\r
-For more help, read the file doc/building.html\r
-\r
-\r
-##################\r
-\r
-To run application:\r
-\r
-java -Djava.ext.dirs=JALVIEW_HOME/lib -cp JALVIEW_HOME/jalview.jar jalview.bin.Jalview\r
-\r
-Replace JALVIEW_HOME with the full path to Jalview Installation Directory.
-\r
-##################\r
-\r
-\r
-If you use a proxy server add \r
-\r
--Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT\r
-\r
-If the proxy server requires authentication, add\r
-\r
--Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD\r
+Jalview README
+==============
+
+Welcome !  
+
+Jalview is free (GPLv3 licensed) software for creation, interactive
+visualisation and analysis of alignments of biological sequences. It
+was developed by Michele Clamp in 1996, and now maintained by the
+Jalview Development team in the Barton group at the University of
+Dundee.
+
+If you'd like to help out please check out the website
+(www.jalview.org) and get in touch. See CITATION for the canonical
+reference if you need to cite Jalview.
+
+To build the Jalview Desktop application and JalviewJS, the JavaScript
+transpiled version (with the help of java2script, courtesy of Bob
+Hanson), you will need a Java 11 JDK and a recent version of
+Gradle. For development we recommend Eclipse - you should be able to
+import Jalview as a Gradle project with the Buildship plugin.
+
+Most likely you'll want to take a look at doc/building.md to find out
+exactly what is needed. If you already have Java 11 and Gradle, then
+the tldr:
+
+gradle test # run functional test suite
+
+gradle shadowJar # build a single executable Jar under build/libs/
+
+gradle jalviewjs # builds JalviewJS under build/jalviewjs  
+
+If you want to build JalviewJS then you will also need to download
+Eclipse for your platform, since transpilation requires an Eclipse
+plugin.