Merge branch 'task/JAL-3234_211_codesigning' into develop
[jalview.git] / doc / building.html
index ecde4d8..f5e0b28 100755 (executable)
 </head>
 <body>
 <h1>Building Jalview from Source</h1>
-<P>
+<p/>
+
+<p>
+You will need the following:<br/>
+<ul>
+  <li> Obtain: git</li>
+  <li> Build/run: Java Development Kit (JDK). JDK11 is now the recommended platform for developing with Jalview.  You can obtain a pre-compiled JDK11 for many platforms from https://adoptopenjdk.net/</li>
+  <li> Build: Gradle 5.1 or later.  On linux you can obtain this with your package manager (e.g. <code>sudo yum install gradle</code> or <code>sudo apt install gradle</code> or on macOS with brew with <code>brew install gradle</code></li>
+</ul>
+With any luck, once you check out the Jalview source from git and set your JAVA_HOME and PATH correctly, you just need to change to the <code>jalview</code> directory and run <code>gradle getdown</code>.
+</p>
+
+<h2>Obtaining Jalview</h2>
+<p>This is easiest achieved with git:
+<pre>git clone http://www.jalview.org/git/jalview.git</pre>
+Then you can <code>cd jalview</code> to get into the top level jalview dir.
+
+
+<p>
+<h2>Minimal Jalview build</h2>
+<p>To run Jalview, you just need the jalview classes and the .jar libraries that Jalview depends on.</p>
+
+
+<!--
 <p>
 You will need the following (hopefully):<br>
 <ul>
@@ -92,6 +115,7 @@ dist. But first you need to make your own key:
                mechanism (e.g. Netbeans' executable Jar and dependent lib directory).
                The hand-crafted ant build.xml is (currently) the only officially
                supported method of building distributable versions of Jalview.</p>
+        -->
 <address>
 <a href="mailto:help@jalview.org">Jalview development team</a>
 </address>