-<html><head>
- <meta charset='utf-8'>
- <meta http-equiv='x-ua-compatible' content='IE=edge'/>
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css">
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
- <script>hljs.initHighlightingOnLoad();</script>
-<style media="screen" type="text/css">
-h1,h2,h3,h4,h5,h6{font-weight:400;color:#111;line-height:1em}code,kbd,pre,samp{color:#000;font-family:monospace,monospace;font-size:.98em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}html{font-size:100%;overflow-y:scroll}body{color:#444;font-family:Georgia,Palatino,Palatino Linotype,Times,Times New Roman,serif;font-size:12px;line-height:1.5em;padding:1em;margin:auto;max-width:42em;background:#fefefe}a{color:#0645ad;text-decoration:none}a:visited{color:#0b0080}a:hover{color:#06e;outline:0}a:active{color:#faa700;outline:0}a:focus{outline:thin dotted}::-moz-selection{background:rgba(255,255,0,.3);color:#000}::selection{background:rgba(255,255,0,.3);color:#000}a::-moz-selection{background:rgba(255,255,0,.3);color:#0645ad}a::selection{background:rgba(255,255,0,.3);color:#0645ad}p{margin:1em 0}img{max-width:100%;border:0;vertical-align:middle}h1{font-size:2.5em}h2{font-size:2em}h3{font-size:1.5em}h4{font-weight:700;font-size:1.2em}h5{font-weight:700;font-size:1em}h6{font-weight:700;font-size:.9em}blockquote{color:#666;margin:0;padding-left:3em;border-left:.5em #eee solid}hr{display:block;height:2px;border:0;border-top:1px solid #aaa;border-bottom:1px solid #eee;margin:1em 0;padding:0}pre{white-space:pre;white-space:pre-wrap;word-wrap:break-word}b{font-weight:700}strong{font-weight:700}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:700}sub{bottom:-.25em}sup{top:-.5em}ul{margin:1em 0;padding:0 0 0 2em}ol{margin:1em 0;padding:0 0 0 2em}dd{margin:0 0 0 2em}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}@media only screen and (min-width:480px){body{font-size:14px}}@media only screen and (min-width:768px){body{font-size:16px}}@media print{*{background:0 0!important;color:#000!important;-webkit-filter:none!important;filter:none!important}body{font-size:12pt;max-width:100%}a{text-decoration:underline}a:visited{text-decoration:underline}hr{height:1px;border:0;border-bottom:1px solid #000}pre{border:1px solid #999;padding-right:1em;page-break-inside:avoid}blockquote{border:1px solid #999;padding-right:1em;page-break-inside:avoid}tr{page-break-inside:avoid}img{page-break-inside:avoid;max-width:100%!important}p{orphans:3;widows:3}h2{orphans:3;widows:3;page-break-after:avoid}h3{orphans:3;widows:3;page-break-after:avoid}a[href]:after{content:"(" attr(href) ")"}abbr[title]:after{content:"(" attr(title) ")"}.ir a:after{content:""}a[href^="javascript:"]:after{content:""}a[href^="#"]:after{content:""}}li p:last-child{margin:0}
-</style>
-</head><body>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
+<head>
+ <meta charset="utf-8" />
+ <meta name="generator" content="pandoc" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+ <title>Building Jalview from Source</title>
+ <style>
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
+ </style>
+ <style>
+a.sourceLine { display: inline-block; line-height: 1.25; }
+a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
+a.sourceLine:empty { height: 1.2em; }
+.sourceCode { overflow: visible; }
+code.sourceCode { white-space: pre; position: relative; }
+div.sourceCode { margin: 1em 0; }
+pre.sourceCode { margin: 0; }
+@media screen {
+div.sourceCode { overflow: auto; }
+}
+@media print {
+code.sourceCode { white-space: pre-wrap; }
+a.sourceLine { text-indent: -1em; padding-left: 1em; }
+}
+pre.numberSource a.sourceLine
+ { position: relative; left: -4em; }
+pre.numberSource a.sourceLine::before
+ { content: attr(title);
+ position: relative; left: -1em; text-align: right; vertical-align: baseline;
+ border: none; pointer-events: all; display: inline-block;
+ -webkit-touch-callout: none; -webkit-user-select: none;
+ -khtml-user-select: none; -moz-user-select: none;
+ -ms-user-select: none; user-select: none;
+ padding: 0 4px; width: 4em;
+ color: #aaaaaa;
+ }
+pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
+div.sourceCode
+ { }
+@media screen {
+a.sourceLine::before { text-decoration: underline; }
+}
+code span.al { color: #ff0000; font-weight: bold; } /* Alert */
+code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
+code span.at { color: #7d9029; } /* Attribute */
+code span.bn { color: #40a070; } /* BaseN */
+code span.bu { } /* BuiltIn */
+code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
+code span.ch { color: #4070a0; } /* Char */
+code span.cn { color: #880000; } /* Constant */
+code span.co { color: #60a0b0; font-style: italic; } /* Comment */
+code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
+code span.do { color: #ba2121; font-style: italic; } /* Documentation */
+code span.dt { color: #902000; } /* DataType */
+code span.dv { color: #40a070; } /* DecVal */
+code span.er { color: #ff0000; font-weight: bold; } /* Error */
+code span.ex { } /* Extension */
+code span.fl { color: #40a070; } /* Float */
+code span.fu { color: #06287e; } /* Function */
+code span.im { } /* Import */
+code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
+code span.kw { color: #007020; font-weight: bold; } /* Keyword */
+code span.op { color: #666666; } /* Operator */
+code span.ot { color: #007020; } /* Other */
+code span.pp { color: #bc7a00; } /* Preprocessor */
+code span.sc { color: #4070a0; } /* SpecialChar */
+code span.ss { color: #bb6688; } /* SpecialString */
+code span.st { color: #4070a0; } /* String */
+code span.va { color: #19177c; } /* Variable */
+code span.vs { color: #4070a0; } /* VerbatimString */
+code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
+ </style>
+ <!--[if lt IE 9]>
+ <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+ <![endif]-->
+ <style>
+ @font-face {
+ font-family: octicons-link;
+ src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff');
+ }
+
+ body {
+ -webkit-text-size-adjust: 100%;
+ text-size-adjust: 100%;
+ color: #333;
+ font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+ font-size: 16px;
+ line-height: 1.6;
+ word-wrap: break-word;
+ width: 728px;
+ max-width: 99%;
+ box-sizing: border-box;
+ padding: 30px 30px 8rem 30px;
+ margin-left: auto;
+ margin-right: auto;
+ }
+
+ body a {
+ background-color: transparent;
+ }
+
+ body a:active,
+ body a:hover {
+ outline: 0;
+ }
+
+ body strong {
+ font-weight: bold;
+ }
+
+ body h1 {
+ font-size: 2em;
+ margin: 0.67em 0;
+ }
+
+ body img {
+ border: 0;
+ }
+
+ body hr {
+ box-sizing: content-box;
+ height: 0;
+ }
+
+ body pre {
+ overflow: auto;
+ }
+
+ body code,
+ body kbd,
+ body pre {
+ font-family: monospace, monospace;
+ font-size: 1em;
+ }
+
+ body input {
+ color: inherit;
+ font: inherit;
+ margin: 0;
+ }
+
+ body html input[disabled] {
+ cursor: default;
+ }
+
+ body input {
+ line-height: normal;
+ }
+
+ body input[type="checkbox"] {
+ box-sizing: border-box;
+ padding: 0;
+ }
+
+ body table {
+ border-collapse: collapse;
+ border-spacing: 0;
+ }
+
+ body td,
+ body th {
+ padding: 0;
+ }
+
+ body * {
+ box-sizing: border-box;
+ }
+
+ body input {
+ font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+ }
+
+ body a {
+ color: #4078c0;
+ text-decoration: none;
+ }
+
+ body a:hover,
+ body a:active {
+ text-decoration: underline;
+ }
+
+ body hr {
+ height: 0;
+ margin: 15px 0;
+ overflow: hidden;
+ background: transparent;
+ border: 0;
+ border-bottom: 1px solid #ddd;
+ }
+
+ body hr:before {
+ display: table;
+ content: "";
+ }
+
+ body hr:after {
+ display: table;
+ clear: both;
+ content: "";
+ }
+
+ body h1,
+ body h2,
+ body h3,
+ body h4,
+ body h5,
+ body h6 {
+ margin-top: 15px;
+ margin-bottom: 15px;
+ line-height: 1.1;
+ }
+
+ body h1 {
+ font-size: 30px;
+ }
+
+ body h2 {
+ font-size: 21px;
+ }
+
+ body h3 {
+ font-size: 16px;
+ }
+
+ body h4 {
+ font-size: 14px;
+ }
+
+ body h5 {
+ font-size: 12px;
+ }
+
+ body h6 {
+ font-size: 11px;
+ }
+
+ body blockquote {
+ margin: 0;
+ }
+
+ body ul,
+ body ol {
+ padding: 0;
+ margin-top: 0;
+ margin-bottom: 0;
+ }
+
+ body ol ol,
+ body ul ol {
+ list-style-type: lower-roman;
+ }
+
+ body ul ul ol,
+ body ul ol ol,
+ body ol ul ol,
+ body ol ol ol {
+ list-style-type: lower-alpha;
+ }
+
+ body dd {
+ margin-left: 0;
+ }
+
+ body code {
+ font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+ font-size: 12px;
+ }
+
+ body pre {
+ margin-top: 0;
+ margin-bottom: 0;
+ font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
+ }
+
+ body .select::-ms-expand {
+ opacity: 0;
+ }
+
+ body .octicon {
+ font: normal normal normal 16px/1 octicons-link;
+ display: inline-block;
+ text-decoration: none;
+ text-rendering: auto;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ }
+
+ body .octicon-link:before {
+ content: '\f05c';
+ }
+
+ body:before {
+ display: table;
+ content: "";
+ }
+
+ body:after {
+ display: table;
+ clear: both;
+ content: "";
+ }
+
+ body>*:first-child {
+ margin-top: 0 !important;
+ }
+
+ body>*:last-child {
+ margin-bottom: 0 !important;
+ }
+
+ body a:not([href]) {
+ color: inherit;
+ text-decoration: none;
+ }
+
+ body .anchor {
+ display: inline-block;
+ padding-right: 2px;
+ margin-left: -18px;
+ }
+
+ body .anchor:focus {
+ outline: none;
+ }
+
+ body h1,
+ body h2,
+ body h3,
+ body h4,
+ body h5,
+ body h6 {
+ margin-top: 1em;
+ margin-bottom: 16px;
+ font-weight: bold;
+ line-height: 1.4;
+ }
+
+ body h1 .octicon-link,
+ body h2 .octicon-link,
+ body h3 .octicon-link,
+ body h4 .octicon-link,
+ body h5 .octicon-link,
+ body h6 .octicon-link {
+ color: #000;
+ vertical-align: middle;
+ visibility: hidden;
+ }
+
+ body h1:hover .anchor,
+ body h2:hover .anchor,
+ body h3:hover .anchor,
+ body h4:hover .anchor,
+ body h5:hover .anchor,
+ body h6:hover .anchor {
+ text-decoration: none;
+ }
+
+ body h1:hover .anchor .octicon-link,
+ body h2:hover .anchor .octicon-link,
+ body h3:hover .anchor .octicon-link,
+ body h4:hover .anchor .octicon-link,
+ body h5:hover .anchor .octicon-link,
+ body h6:hover .anchor .octicon-link {
+ visibility: visible;
+ }
+
+ body h1 {
+ padding-bottom: 0.3em;
+ font-size: 1.75em;
+ line-height: 1.2;
+ }
+
+ body h1 .anchor {
+ line-height: 1;
+ }
+
+ body h2 {
+ padding-bottom: 0.3em;
+ font-size: 1.5em;
+ line-height: 1.225;
+ }
+
+ body h2 .anchor {
+ line-height: 1;
+ }
+
+ body h3 {
+ font-size: 1.25em;
+ line-height: 1.43;
+ }
+
+ body h3 .anchor {
+ line-height: 1.2;
+ }
+
+ body h4 {
+ font-size: 1em;
+ }
+
+ body h4 .anchor {
+ line-height: 1.2;
+ }
+
+ body h5 {
+ font-size: 1em;
+ }
+
+ body h5 .anchor {
+ line-height: 1.1;
+ }
+
+ body h6 {
+ font-size: 1em;
+ color: #777;
+ }
+
+ body h6 .anchor {
+ line-height: 1.1;
+ }
+
+ body p,
+ body blockquote,
+ body ul,
+ body ol,
+ body dl,
+ body table,
+ body pre {
+ margin-top: 0;
+ margin-bottom: 16px;
+ }
+
+ body hr {
+ height: 4px;
+ padding: 0;
+ margin: 16px 0;
+ background-color: #e7e7e7;
+ border: 0 none;
+ }
+
+ body ul,
+ body ol {
+ padding-left: 2em;
+ }
+
+ body ul ul,
+ body ul ol,
+ body ol ol,
+ body ol ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ }
+
+ body li>p {
+ margin-top: 16px;
+ }
+
+ body dl {
+ padding: 0;
+ }
+
+ body dl dt {
+ padding: 0;
+ margin-top: 16px;
+ font-size: 1em;
+ font-style: italic;
+ font-weight: bold;
+ }
+
+ body dl dd {
+ padding: 0 16px;
+ margin-bottom: 16px;
+ }
+
+ body blockquote {
+ padding: 0 15px;
+ color: #777;
+ border-left: 4px solid #ddd;
+ }
+
+ body blockquote>:first-child {
+ margin-top: 0;
+ }
+
+ body blockquote>:last-child {
+ margin-bottom: 0;
+ }
+
+ body table {
+ display: block;
+ width: 100%;
+ overflow: auto;
+ word-break: normal;
+ word-break: keep-all;
+ }
+
+ body table th {
+ font-weight: bold;
+ }
+
+ body table th,
+ body table td {
+ padding: 6px 13px;
+ border: 1px solid #ddd;
+ }
+
+ body table tr {
+ background-color: #fff;
+ border-top: 1px solid #ccc;
+ }
+
+ body table tr:nth-child(2n) {
+ background-color: #f8f8f8;
+ }
+
+ body img {
+ max-width: 100%;
+ box-sizing: content-box;
+ background-color: #fff;
+ }
+
+ body code {
+ padding: 0;
+ padding-top: 0;
+ padding-bottom: 0;
+ margin: 0;
+ font-size: 85%;
+ background-color: rgba(0,0,0,0.04);
+ border-radius: 3px;
+ }
+
+ body code:before,
+ body code:after {
+ letter-spacing: -0.2em;
+ content: "\00a0";
+ }
+
+ body pre>code {
+ padding: 0;
+ margin: 0;
+ font-size: 100%;
+ word-break: normal;
+ white-space: pre;
+ background: transparent;
+ border: 0;
+ }
+
+ body .highlight {
+ margin-bottom: 16px;
+ }
+
+ body .highlight pre,
+ body pre {
+ padding: 16px;
+ overflow: auto;
+ font-size: 85%;
+ line-height: 1.45;
+ background-color: #f7f7f7;
+ border-radius: 3px;
+ }
+
+ body .highlight pre {
+ margin-bottom: 0;
+ word-break: normal;
+ }
+
+ body pre {
+ word-wrap: normal;
+ }
+
+ body pre code {
+ display: inline;
+ max-width: initial;
+ padding: 0;
+ margin: 0;
+ overflow: initial;
+ line-height: inherit;
+ word-wrap: normal;
+ background-color: transparent;
+ border: 0;
+ }
+
+ body pre code:before,
+ body pre code:after {
+ content: normal;
+ }
+
+ body kbd {
+ display: inline-block;
+ padding: 3px 5px;
+ font-size: 11px;
+ line-height: 10px;
+ color: #555;
+ vertical-align: middle;
+ background-color: #fcfcfc;
+ border: solid 1px #ccc;
+ border-bottom-color: #bbb;
+ border-radius: 3px;
+ box-shadow: inset 0 -1px 0 #bbb;
+ }
+
+ body .pl-c {
+ color: #969896;
+ }
+
+ body .pl-c1,
+ body .pl-s .pl-v {
+ color: #0086b3;
+ }
+
+ body .pl-e,
+ body .pl-en {
+ color: #795da3;
+ }
+
+ body .pl-s .pl-s1,
+ body .pl-smi {
+ color: #333;
+ }
+
+ body .pl-ent {
+ color: #63a35c;
+ }
+
+ body .pl-k {
+ color: #a71d5d;
+ }
+
+ body .pl-pds,
+ body .pl-s,
+ body .pl-s .pl-pse .pl-s1,
+ body .pl-sr,
+ body .pl-sr .pl-cce,
+ body .pl-sr .pl-sra,
+ body .pl-sr .pl-sre {
+ color: #183691;
+ }
+
+ body .pl-v {
+ color: #ed6a43;
+ }
+
+ body .pl-id {
+ color: #b52a1d;
+ }
+
+ body .pl-ii {
+ background-color: #b52a1d;
+ color: #f8f8f8;
+ }
+
+ body .pl-sr .pl-cce {
+ color: #63a35c;
+ font-weight: bold;
+ }
+
+ body .pl-ml {
+ color: #693a17;
+ }
+
+ body .pl-mh,
+ body .pl-mh .pl-en,
+ body .pl-ms {
+ color: #1d3e81;
+ font-weight: bold;
+ }
+
+ body .pl-mq {
+ color: #008080;
+ }
+
+ body .pl-mi {
+ color: #333;
+ font-style: italic;
+ }
+
+ body .pl-mb {
+ color: #333;
+ font-weight: bold;
+ }
+
+ body .pl-md {
+ background-color: #ffecec;
+ color: #bd2c00;
+ }
+
+ body .pl-mi1 {
+ background-color: #eaffea;
+ color: #55a532;
+ }
+
+ body .pl-mdr {
+ color: #795da3;
+ font-weight: bold;
+ }
+
+ body .pl-mo {
+ color: #1d3e81;
+ }
+
+ body kbd {
+ display: inline-block;
+ padding: 3px 5px;
+ font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
+ line-height: 10px;
+ color: #555;
+ vertical-align: middle;
+ background-color: #fcfcfc;
+ border: solid 1px #ccc;
+ border-bottom-color: #bbb;
+ border-radius: 3px;
+ box-shadow: inset 0 -1px 0 #bbb;
+ }
+
+ body .task-list-item {
+ list-style-type: none;
+ }
+
+ body .task-list-item+.task-list-item {
+ margin-top: 3px;
+ }
+
+ body .task-list-item input {
+ margin: 0 0.35em 0.25em -1.6em;
+ vertical-align: middle;
+ }
+
+ body :checked+.radio-label {
+ z-index: 1;
+ position: relative;
+ border-color: #4078c0;
+ }
+ </style>
+</head>
+<body>
+<nav id="TOC" role="doc-toc">
+<ul>
+<li><a href="#building-jalview-from-source">Building Jalview from Source</a><ul>
+<li><a href="#tldr">tl;dr</a></li>
+<li><a href="#setting-up">Setting up</a><ul>
+<li><a href="#java-11-compliant-jdk">Java 11 compliant JDK</a></li>
+<li><a href="#gradle-and-git">gradle and git</a></li>
+</ul></li>
+<li><a href="#downloading-the-jalview-source-tree">Downloading the Jalview source tree</a><ul>
+<li><a href="#whats-in-the-source-tree">What’s in the source tree?</a></li>
+</ul></li>
+<li><a href="#building-jalview">Building Jalview</a><ul>
+<li><a href="#minimal-jalview-build">Minimal Jalview Build</a></li>
+<li><a href="#jalview-in-a-jar-file">Jalview in a Jar File</a></li>
+<li><a href="#distributed-jar-files">Distributed Jar Files</a></li>
+<li><a href="#single-shadow-jar-file">Single <em>shadow</em> Jar File</a></li>
+<li><a href="#building-the-getdown-launcher">Building the <code>getdown</code> launcher</a></li>
+<li><a href="#running-tests">Running tests</a></li>
+<li><a href="#installer-packaging-with-install4j">Installer packaging with <em>install4j</em></a></li>
+</ul></li>
+<li><a href="#building-in-eclipse">Building in Eclipse</a></li>
+<li><a href="#gradle-properties">Gradle properties</a></li>
+</ul></li>
+</ul>
+</nav>
<h1 id="building-jalview-from-source">Building Jalview from Source</h1>
-<h2 id="what-you-will-need">What you will need</h2>
+<h2 id="tldr">tl;dr</h2>
+<pre><code># download
+git clone http://source.jalview.org/git/jalview.git
+# compile
+cd jalview
+gradle shadowJar
+# run
+java -jar build/libs/jalview-all-11.jar
+
+# and/or create launcher
+gradle getdown
+# use launcher
+cd getdown/files
+java -jar getdown-launcher.jar . jalview</code></pre>
+<h2 id="setting-up">Setting up</h2>
<p>The method here is described in terms of using a command line. You can easily do this on linux or in a Terminal window in macOS. You can do it in Windows.</p>
<ul>
<li>Java 11 compliant JDK</li>
<li>gradle 5.1 or above</li>
<li>git</li>
</ul>
-<h3 id="java-11-jdk">Java 11 JDK</h3>
-<p>We recommend obtaining an OpenJDK JDK 11 from AdoptOpenJDK: <a href="https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot" class="uri">https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot</a>, either the <em>Installer</em> or <code>.zip</code>/<code>.tar.gz</code> variants whichever you prefer (if you’re not sure, choose the <em>Installer</em>).</p>
-<h3 id="gradle-and-git"><code>gradle</code> and <code>git</code></h3>
-<p>You should be able to install the latest (or close to the latest) versions of gradle and git using your OS package manager.</p>
-<p>For <strong>macOS</strong> we recommend using <code>brew</code>, which can be installed following the instructions at <a href="https://brew.sh/" class="uri">https://brew.sh/</a>. After installing <code>brew</code>, open a Terminal window and type in (using an Administrator privileged user): <code>brew install gradle git</code> or <code>brew upgrade gradle git</code> if you already have them installed but need to upgrade the version.</p>
-<p>For <strong>linux</strong> this will depend on which distribution you’re using. For <em>debian</em> based distributions (e.g. Mint, Ubuntu, Debian) run <code>sudo apt-get install gradle git</code> whilst for RPM-based distributions run (probably) <code>sudo yum install gradle git</code> If you have some other version of linux you’ll probably be able to work it out!</p>
-<p>For <em>Windows</em> users, you might do well by using the <strong>Chocolatey</strong> package manager. See install instructions at <a href="https://chocolatey.org/" class="uri">https://chocolatey.org/</a>, and you will just need <code>choco install gradle git</code> Alternatively, you could install a real <code>bash</code> shell and install both <code>gradle</code> and <code>git</code> through <code>apt-get</code>. Another alternative would be to install them separately following the instructions at <a href="https://gradle.org/install/" class="uri">https://gradle.org/install/</a>, and for <code>git</code> here are a couple of suggestions: Git for Windows <a href="https://gitforwindows.org/" class="uri">https://gitforwindows.org/</a> or a real <code>bash</code>-shell <a href="https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/" class="uri">https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/</a> !</p>
-<h2 id="section"></h2>
-
-</body></html>
\ No newline at end of file
+<blockquote>
+<p>The versions and installation methods here are just suggestions (which we have tested so are known to work). If you need or wish to use different implementations (particularly you might need a bespoke JDK if you are on an exotic architecture) then the general build instructions should work with any gradle 5+. You should be able to compile the bytecode with any JDK Java 11+. The resulting bytecode (in particular the shadow jar) should be runnable in any JRE Java 1.8+. Remember that because Jalview and the getdown launcher are Java bytecode you can build on one system where you might have gradle, and run on another where you don’t (JRE 1.8+ required).</p>
+</blockquote>
+<h3 id="java-11-compliant-jdk">Java 11 compliant JDK</h3>
+<h4 id="all-platforms">All platforms</h4>
+<p>We recommend obtaining an OpenJDK JDK 11 (since 11 is the long term support release) from AdoptOpenJDK: <a href="https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot" class="uri">https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot</a>, either the <em>Installer</em> or <code>.zip</code>/<code>.tar.gz</code> variants whichever you prefer (if you’re not sure, choose the <em>Installer</em>).</p>
+<blockquote>
+<h5 id="alternativecli-install-of-adoptopenjdk-11">Alternative/CLI install of AdoptOpenJDK 11</h5>
+<p>You can also install adoptopenjdk11 using either <code>brew</code> (macOS), <code>choco</code> (Windows) (see the section on <code>gradle</code> and <code>git</code> for more informaiton on <code>brew</code> and <code>choco</code>) or <code>yum</code> or <code>apt</code> (Linux):</p>
+<h6 id="alternative-for-macos-and-homebrew">alternative for MacOS and Homebrew</h6>
+<pre><code>brew tap adoptopenjdk/openjdk
+brew cask install adoptopenjdk11</code></pre>
+<h6 id="alternative-for-windows-and-chocolatey">alternative for Windows and Chocolatey</h6>
+<pre><code>choco install adoptopenjdk11</code></pre>
+<h6 id="alternative-for-linux-with-yumapt">alternative for Linux with yum/apt</h6>
+<p>see <a href="https://adoptopenjdk.net/installation.html#linux-pkg" class="uri">https://adoptopenjdk.net/installation.html#linux-pkg</a></p>
+</blockquote>
+<h3 id="gradle-and-git">gradle and git</h3>
+<p>You should be able to install the latest (or sufficiently recent) versions of gradle and git using your OS package manager.</p>
+<h4 id="macos">MacOS</h4>
+<p>we recommend using <code>brew</code>, which can be installed following the instructions at <a href="https://brew.sh/" class="uri">https://brew.sh/</a>. After installing <code>brew</code>, open a Terminal window and type in (using an Administrator privileged user):</p>
+<div class="sourceCode" id="cb4"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb4-1" title="1"><span class="ex">brew</span> install gradle git</a></code></pre></div>
+<p>or if you aready have them installed but need to upgrade the version:</p>
+<div class="sourceCode" id="cb5"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb5-1" title="1"><span class="ex">brew</span> upgrade gradle git</a></code></pre></div>
+<h4 id="windows">Windows</h4>
+<p>we suggest using the <strong>Chocolatey</strong> package manager. See install instructions at <a href="https://chocolatey.org/" class="uri">https://chocolatey.org/</a>, and you will just need</p>
+<div class="sourceCode" id="cb6"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb6-1" title="1"><span class="ex">choco</span> install gradle</a>
+<a class="sourceLine" id="cb6-2" title="2"><span class="ex">choco</span> install git</a></code></pre></div>
+<p>Alternatively, you could install a real <code>bash</code> shell and install both <code>gradle</code> and <code>git</code> through <code>apt-get</code>. See <a href="https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/" class="uri">https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/</a> for how to install the ubuntu bash shell in Windows 10.</p>
+<p>Another alternative would be to install them separately. For <code>gradle</code> follow the instructions at <a href="https://gradle.org/install/" class="uri">https://gradle.org/install/</a>, and for <code>git</code> here are a couple of suggestions: Git for Windows <a href="https://gitforwindows.org/" class="uri">https://gitforwindows.org/</a>. Getting the individual installs working together on the command line will be trickier so we recommend using Chocolatey or bash.</p>
+<h4 id="linux">Linux</h4>
+<p>this will depend on which distribution you’re using.</p>
+<h5 id="for-debian-based-distributions-e.g.-mint-ubuntu-debian">For <em>Debian</em> based distributions (e.g. Mint, Ubuntu, Debian)</h5>
+<p>run</p>
+<div class="sourceCode" id="cb7"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb7-1" title="1"> <span class="fu">sudo</span> apt-get install gradle git</a></code></pre></div>
+<h5 id="for-rpm-based-distributions-e.g.-fedora-centos-redhat">for RPM-based distributions (e.g. Fedora, CentOS, RedHat)</h5>
+<p>run</p>
+<div class="sourceCode" id="cb8"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb8-1" title="1"><span class="fu">sudo</span> yum install gradle git</a></code></pre></div>
+<p>If you have some other version of linux you’ll probably be able to work it out!</p>
+<h2 id="downloading-the-jalview-source-tree">Downloading the Jalview source tree</h2>
+<p>This can be done with <code>git</code>. On the command line, change directory to where you want to download Jalview’s build-tree top level directory. Then run</p>
+<div class="sourceCode" id="cb9"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb9-1" title="1"><span class="fu">git</span> clone http://source.jalview.org/git/jalview.git</a></code></pre></div>
+<p>You’ll get some progress output and after a minute or two you should have the full Jalview build-tree in the folder <code>jalview</code>.</p>
+<h3 id="whats-in-the-source-tree">What’s in the source tree?</h3>
+<p>Jalview is a mature product with its codebase going back many years. As such it doesn’t have a folder structure that most new gradle projects would have, so you might not find everything in the place you might expect. Here’s a brief description of what you might find in the main folders under the <code>jalview</code> tree.</p>
+<p>Within the <code>jalview</code> folder you will find (of possible interest):</p>
+<table>
+<colgroup>
+<col style="width: 15%" />
+<col style="width: 84%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th>dir/ or file</th>
+<th>contains</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td><code>bin/</code></td>
+<td>used by eclipse for compiled classes – no need to touch this</td>
+</tr>
+<tr class="even">
+<td><code>build/</code></td>
+<td>the gradle build dir</td>
+</tr>
+<tr class="odd">
+<td><code>classes/</code></td>
+<td>contains the compiled Java classes for the Jalview application</td>
+</tr>
+<tr class="even">
+<td><code>dist/</code></td>
+<td>assembled <code>.jar</code> files needed to run Jalview application</td>
+</tr>
+<tr class="odd">
+<td><code>examples/</code></td>
+<td>example input files usable by Jalview</td>
+</tr>
+<tr class="even">
+<td><code>getdown/</code></td>
+<td>the libraries used by the Javliew launcher (getdown)</td>
+</tr>
+<tr class="odd">
+<td><code>getdown/src/</code></td>
+<td>our modified source for <code>getdown</code></td>
+</tr>
+<tr class="even">
+<td><code>getdown/website/</code></td>
+<td>the assembled “download” folder used by getdown for downloads/upgrades</td>
+</tr>
+<tr class="odd">
+<td><code>getdown/files/</code></td>
+<td>the minimal fileset to launch the Jalview launcher, which can then download the rest of the Jalview application</td>
+</tr>
+<tr class="even">
+<td><code>help/</code></td>
+<td>the help documents</td>
+</tr>
+<tr class="odd">
+<td><code>j8lib/</code></td>
+<td>libraries needed to run Jalview under Java 1.8</td>
+</tr>
+<tr class="even">
+<td><code>j11lib/</code></td>
+<td>libraries needed to run Jalivew under Java 11</td>
+</tr>
+<tr class="odd">
+<td><code>resource/</code></td>
+<td>non-java resources used in the Jalview application</td>
+</tr>
+<tr class="even">
+<td><code>src/</code></td>
+<td>the Jalview application source <code>.java</code> files</td>
+</tr>
+<tr class="odd">
+<td><code>test/</code></td>
+<td>Test class source files</td>
+</tr>
+<tr class="even">
+<td><code>utils/</code></td>
+<td>helper applications used in the build process</td>
+</tr>
+<tr class="odd">
+<td><code>utils/install4j/</code></td>
+<td>files used by the packaging tool, install4j</td>
+</tr>
+<tr class="even">
+<td><code>build.gradle</code></td>
+<td>the build file used by gradle</td>
+</tr>
+<tr class="odd">
+<td><code>gradle.properties</code></td>
+<td>configurable properties for the build process</td>
+</tr>
+</tbody>
+</table>
+<p>Note that you need a Java 11 JDK to compile Jalview whether your target build is Java 1.8 or Java 11.</p>
+<h2 id="building-jalview">Building Jalview</h2>
+<p>You will need to have the Java 11 <code>javac</code> in your path, or alternatively you can configure gradle to know where this is by putting</p>
+<pre><code>org.gradle.java.home=/path_to_jdk_directory</code></pre>
+<p>in the <code>gradle.properties</code> file.</p>
+<blockquote>
+<p><em>You may want to see some of the other properties you can change at the end of this document.</em></p>
+</blockquote>
+<h3 id="minimal-jalview-build">Minimal Jalview Build</h3>
+<p>To compile the necessary class files, just run</p>
+<div class="sourceCode" id="cb11"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb11-1" title="1"><span class="ex">gradle</span> compileJava</a></code></pre></div>
+<p>to compile the classes into the <code>classes</code> folder. You should now be able to run the Jalview application directly with</p>
+<div class="sourceCode" id="cb12"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb12-1" title="1"><span class="ex">java</span> -cp <span class="st">"classes:resources:help:j11lib/*"</span> jalview.bin.Jalview</a></code></pre></div>
+<p>You can also run with an automatic large memory setting (which will set the maximum memory heap of the Jalview JVM to 90% of your local physical memory) and docked icon setting (if possible in your OS) with</p>
+<div class="sourceCode" id="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb13-1" title="1"><span class="ex">java</span> -cp <span class="st">"classes:resources:help:j11lib/*"</span> jalview.bin.Launcher</a></code></pre></div>
+<blockquote>
+<p><em>You must use just “<code>j11lib/*</code>” and not “<code>j11lib/*.jar</code>” as this is a special Java classpath argument wildcard interpreted by <code>java</code>, <strong>not</strong> a shell expansion wildcard interpreted by the shell.</em></p>
+</blockquote>
+<p>Note that <code>jalview.bin.Launcher</code> is a simplified launcher class that re-launches <code>jalview.bin.Jalview</code> with the same JRE (<em>not</em> the same JVM instance), classpath and arguments, but with an automatically determined <code>-Xmx...</code> memory setting if one hasn’t been provided.</p>
+<h3 id="jalview-in-a-jar-file">Jalview in a Jar File</h3>
+<p>To package the <code>classes</code>, <code>resources</code>, and <code>help</code> into one jar, you can run</p>
+<div class="sourceCode" id="cb14"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb14-1" title="1"><span class="ex">gradle</span> jar</a></code></pre></div>
+<p>which assembles the Jalview classes and resources into <code>dist/jalview.jar</code></p>
+<p>To run this, use</p>
+<div class="sourceCode" id="cb15"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb15-1" title="1"><span class="ex">java</span> -cp <span class="st">"dist/jalview.jar:j11lib/*"</span> jalview.bin.Jalview</a></code></pre></div>
+<h3 id="distributed-jar-files">Distributed Jar Files</h3>
+<p>To simplify this, all required <code>.jar</code> files can be assembled into the <code>dist</code> folder using</p>
+<div class="sourceCode" id="cb16"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb16-1" title="1"><span class="ex">gradle</span> makeDist</a></code></pre></div>
+<p>which puts all required jar files into <code>dist</code> so you can run with</p>
+<div class="sourceCode" id="cb17"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb17-1" title="1"><span class="ex">java</span> -cp <span class="st">"dist/*"</span> jalview.bin.Jalview</a></code></pre></div>
+<h3 id="single-shadow-jar-file">Single <em>shadow</em> Jar File</h3>
+<p>The shadow jar file is a single <code>.jar</code> that contains all required classes and resources from <code>jalview.jar</code> and all of the supporting libraries in <code>j11lib/*.jar</code> merged into one <code>.jar</code> archive file. A default launching class (<code>MAIN-CLASS: jalview.bin.Launcher</code>) is specified in the <code>.jar</code> manifest file (<code>META/MANIFEST.MF</code>) so a start class doesn’t need to be specified.</p>
+<p>Build the shadow jar file in <code>build/lib/jalview-all-11.jar</code> with</p>
+<div class="sourceCode" id="cb18"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb18-1" title="1"><span class="ex">gradle</span> shadowJar</a></code></pre></div>
+<p>and run it with</p>
+<div class="sourceCode" id="cb19"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb19-1" title="1"><span class="ex">java</span> -jar build/lib/jalview-all-11.jar</a></code></pre></div>
+<p>Because no arguments are required, most OSes will associate a <code>.jar</code> file with the <code>java</code> application (if this has been installed through the OS and not just a local unzip) as a <code>-jar</code> argument so you may find you can launch <code>jalview-all-11.jar</code> just by double-clicking on it)!</p>
+<blockquote>
+<p>The <code>shadowJar</code> task is not a requirement for any other task, so to build the shadow jar file you must specify the <code>shadowJar</code> task.</p>
+</blockquote>
+<blockquote>
+<p>The shadow jar file represents probably the simplest way to distribute the Jalview application to machines that already have a Java 11 installed, although without the many and compelling benefits of the <code>getdown</code> launcher.</p>
+</blockquote>
+<h3 id="building-the-getdown-launcher">Building the <code>getdown</code> launcher</h3>
+<p>We have made significant customisations to the <code>getdown</code> launcher which you can find in <code>getdown/src/getdown</code>.</p>
+<blockquote>
+<p>You don’t need to build this afresh as the required <code>gradle-core.jar</code> and <code>gradle-launcher.jar</code> files are already distributed in <code>j11lib</code> and <code>getdown/lib</code> but if you want to, then you’ll need a working Maven and also a Java 8 JDK. Ensure the Java 8 <code>javac</code> is forefront in your path and do</p>
+<div class="sourceCode" id="cb20"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb20-1" title="1"><span class="bu">cd</span> getdown/src/getdown</a>
+<a class="sourceLine" id="cb20-2" title="2"><span class="ex">mvn</span> clean package -Dgetdown.host.whitelist=<span class="st">"jalview.org,*.jalview.org"</span></a></code></pre></div>
+<p>and you will find the required <code>.jar</code> files in <code>core/target/gradle-core-XXX.jar</code> and <code>launcher/target/gradle-launcher-XXX.jar</code>. The <code>gradle-core.jar</code> should then be copied to all three of the <code>j8lib</code>, <code>j11lib</code> and <code>getdown/lib</code> folders, whilst the <code>gradle-launcher.jar</code> only needs to be copied to <code>getdown/lib</code>.</p>
+<p>The <code>mvn</code> command should ideally include the <code>-Dgetdown.host.whitelist=*.jalview.org</code> setting. This, and the necessary file copying commands, can be found in <code>getdown/src/getdown/mvn_cmd</code>.</p>
+</blockquote>
+<p>To assemble Jalview with <code>getdown</code> use the following gradle task:</p>
+<div class="sourceCode" id="cb21"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb21-1" title="1"><span class="ex">gradle</span> getdown</a></code></pre></div>
+<p>This puts all the necessary files to launch Jalview with <code>getdown</code> into <code>getdown/website/11/</code>. This could be treated as the reference folder for <code>getdown</code>, which is where a getdown launcher will check to see if the Jalview application files it has are up to date, and download if they aren’t or it simply doesn’t have them.</p>
+<p>A minimal getdown-launcher can be found in <code>getdown/files/11/</code> which checks its up-to-date status with (the absolute path to) <code>getdown/website/11/</code>.</p>
+<p>This can be launched with</p>
+<div class="sourceCode" id="cb22"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb22-1" title="1"><span class="ex">java</span> -jar getdown/files/11/getdown-launcher.jar getdown/files/11/ jalview</a></code></pre></div>
+<blockquote>
+<p>We’ve already met the <code>-jar file.jar</code> arguments. The next argument is the working folder for getdown, and the final argument, “<code>jalview</code>”, is a getdown application id (only “<code>jalview</code>” is defined here).</p>
+</blockquote>
+<h3 id="running-tests">Running tests</h3>
+<p>There are substantial tests written for Jalview that use TestNG, which you can run with</p>
+<div class="sourceCode" id="cb23"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb23-1" title="1"><span class="ex">gradle</span> test</a></code></pre></div>
+<p>These normally take around 5 - 10 minutes to complete and outputs its full results into the <code>tests/</code> folder. A summary of results should appear in your console.</p>
+<h3 id="installer-packaging-with-install4j">Installer packaging with <em>install4j</em></h3>
+<p>Jalview is currently using <em>install4j</em> <a href="https://www.ej-technologies.com/products/install4j/overview.html" class="uri">https://www.ej-technologies.com/products/install4j/overview.html</a> as its installer packaging tool.</p>
+<p>If you have a licensed installation of <em>install4j</em> you can build Jalview installers by running</p>
+<div class="sourceCode" id="cb24"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb24-1" title="1"><span class="ex">gradle</span> installers</a></code></pre></div>
+<p>though you may need to fiddle with the <code>install4j</code> and <code>copyInstall4jTemplate</code> tasks in <code>build.gradle</code> file to point to your installation of <em>install4j</em> and also to bundled JREs if you want to bundle those into the installers.</p>
+<p>If you want more details, get in touch on our development mailing list <a href="mailto:jalview-dev@jalview.org" class="email">jalview-dev@jalview.org</a>. Sign up at <a href="http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev" class="uri">http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev</a>.</p>
+<h2 id="building-in-eclipse">Building in Eclipse</h2>
+<p>We develop in Eclipse, and support settings to develop and save Jalview source code in our preferred style. We also support running the Jalview application, debugging and running tests with TestNG from within Eclipse.</p>
+<p>To get Jalview set up as a project in Eclipse, we recommend using at least the 2019-03 version of Eclipse IDE for Java Developers which you can download from the Eclipse website: <a href="https://www.eclipse.org/downloads/" class="uri">https://www.eclipse.org/downloads/</a></p>
+<p>Once installed, we also recommend installing several plugins from the Eclipse Marketplace.</p>
+<p>To do so, launch Eclipse, and go to Help->Eclipse Marketplace…</p>
+<p>Search for and install:</p>
+<ol type="1">
+<li>Buildship Gradle Integration 3.0 (or greater)</li>
+<li>Groovy Development Tools 3.4.0 (or greater)</li>
+<li>TestNG for Eclipse (optional – only needed if you want to run tests from Eclipse)</li>
+</ol>
+<blockquote>
+<p>At time of writing, TestNG for Eclipse does not show up in the Eclipse Marketplace as the latest released version does not install in Eclipse 2019-03. However, you can install a working beta of TestNG for Eclipse by going to</p>
+<p>Help->Install New Software…</p>
+<p>and entering</p>
+<p><code>TestNG Eclipse Composite P2 Repo - http://beust.com/eclipse-beta</code></p>
+<p>into the <em>Work with</em> box and click on the <em>Add…</em> button.</p>
+<p>Eclipse might pause for a bit with the word <em>Pending</em> in the table below at this point, but it will eventually list TestNG with a selection box under the <em>Name</em> column.</p>
+<p>Select <em>TestNG</em> and carry on through the install process to install the TestNG plugin.</p>
+</blockquote>
+<p>After installing the plugins, it is a good to get Java 11 set up in Eclipse as the default JRE.</p>
+<p>To do this go to Preferences (Eclipse->Preferences in macOS, File->Preferences on Windows or Window->Preferences on Linux) and find</p>
+<p>Java -> Installed JREs</p>
+<p>If your Java 11 installation is not listed, click on</p>
+<p><em>Add</em> -> Standard VM -> <em>Next</em></p>
+<p>and enter the JRE home. You can browse to where it was installed. Give it a name (like “AdoptOpenJDK 11”). Select this JDK as the default JRE and click on <em>Apply and Close</em>.</p>
+<p>You can now import Jalview. It is important to import Jalview as a Gradle project (not as a Java project), so go to</p>
+<p>File->Import…</p>
+<p>find and select</p>
+<p>Gradle->Existing Gradle Project</p>
+<p>and then click on the <em>Next ></em> button.</p>
+<p>In the following options, it is the <em>Project Root Directory</em> you should set to be the <code>jalview</code> folder that git downloaded. Then you can click on the <em>Finish</em> button.</p>
+<h2 id="gradle-properties">Gradle properties</h2>
+<p>There are a lot of properties configured in <code>gradle.properties</code> which we strongly recommend being left as they are unless you have a specific problem with the build process.</p>
+<p>There are a few gradle properties you might want to set on the command line with the <code>-P</code> flag when building a version of Jalview with specific requirements:</p>
+<h4 id="java_version"><code>JAVA_VERSION</code></h4>
+<p>This changes the <em>target</em> java bytecode version > NOTE that you will need to use a Java 11 (or greater) JDK Java compiler to build Jalview for any byte-code target version.</p>
+<p>Valid values are <code>11</code> and <code>1.8</code>.</p>
+<p>e.g.</p>
+<div class="sourceCode" id="cb25"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb25-1" title="1"><span class="ex">gradle</span> shadowJar -PJAVA_VERSION=1.8</a></code></pre></div>
+<p>When using <code>-PJAVA_VERSION=1.8</code> the libraries from <code>j8lib</code> (instead of <code>j11lib</code>) will be used in the compile<br />
+and runtime classpath and also used in the <code>makeDist</code> build step. Where a Java version of <code>11</code> is used in folder and file names, it will instead use <code>1.8</code>. Also if you are building installer packages with <em>install4j</em> the package builder will look for JRE 1.8 bundles to package in the installers.</p>
+<blockquote>
+<p>Note that continued development of Jalview will assume a Java 11+ runtime environment, the 2.11.0 release will run under a Java 1.8 JRE with a few minor features disabled.</p>
+</blockquote>
+<h4 id="channel"><code>CHANNEL</code></h4>
+<p>This changes the <code>appbase</code> setting in <code>getdown.txt</code> (<code>appbase</code> is where the getdown launcher looks to see if there’s an updated file) to point to a particular Jalview channel. Expected values are <code>FILE</code>, <code>STABLE</code>, <code>DEVELOPMENT</code>, or a specific version of Jalview like <code>2.11</code> or <code>2.10.5</code>.</p>
+<p>A value of <code>FILE</code> behaves differently to the other expected values and will use a local file-system scheme URI instead of a Jalview release channel. This <code>file:</code> scheme URI uses an absolute path to the <code>getdown/website/<JAVA_VERSION></code></p>
+<p>On a regular development machine, this property will default to <code>LOCAL</code>.</p>
+<p>e.g.</p>
+<div class="sourceCode" id="cb26"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb26-1" title="1"><span class="ex">gradle</span> getdown -PCHANNEL=DEVELOPMENT</a></code></pre></div>
+<h4 id="media_types"><code>MEDIA_TYPES</code></h4>
+<p>If you are building <em>install4j</em> installers (requires <em>install4j</em> to be installed) then this property specifies a comma-separated list of media types (i.e. platform specific installers) <em>install4j</em> should actually build.</p>
+<p>Currently the valid values are <code>linuxDeb</code>, <code>linuxRPM</code>, <code>macosArchive</code>, <code>unixArchive</code>, <code>unixInstaller</code>, <code>windows</code></p>
+<p>The default value is all of them.</p>
+<p>e.g.</p>
+<div class="sourceCode" id="cb27"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb27-1" title="1"><span class="ex">gradle</span> installers -PJAVA_VERSION=1.8 -PMEDA_TYPE=macosArchive</a></code></pre></div>
+<p>To get an up-to-date list of possible values, you can run</p>
+<div class="sourceCode" id="cb28"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb28-1" title="1"><span class="fu">perl</span> -n -e <span class="st">'m/^\s*<(\w+)[^>]*\bmediaFileName=/ && print "$1\n";'</span> utils/install4j/install4j_template.install4j <span class="kw">|</span> <span class="fu">sort</span> -u</a></code></pre></div>
+<p>in the <code>jalview</code> root folder.</p>
+</body>
+</html>
* gradle 5.1 or above
* git
-### Java 11 JDK
+> The versions and installation methods here are just suggestions (which we have tested
+so are known to work). If you need or wish to use different implementations (particularly
+you might need a bespoke JDK if you are on an exotic architecture) then the general
+build instructions should work with any gradle 5+. You should be able to compile the
+bytecode with any JDK Java 11+. The resulting bytecode (in particular the shadow jar)
+should be runnable in any JRE Java 1.8+. Remember that because Jalview and the getdown launcher
+are Java bytecode you can build on one system where you might have gradle, and run
+on another where you don't (JRE 1.8+ required).
+
+### Java 11 compliant JDK
#### All platforms
We recommend obtaining an OpenJDK JDK 11 (since 11 is the long term support release) from AdoptOpenJDK: <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>, either the *Installer* or `.zip`/`.tar.gz` variants whichever you prefer (if you're not sure, choose the *Installer*).
-You can also install adoptopenjdk11 using either `brew` (macOS) or `choco` (Windows):
-
-#### alternative MacOS/Homebrew
-```
-brew tap adoptopenjdk/openjdk
-brew cask install adoptopenjdk11
-```
-
-#### alternative Windows/Chocolatey
-```
-choco install adoptopenjdk11
-```
-
-#### alternative Linux/yum|apt
-
-see <https://adoptopenjdk.net/installation.html#linux-pkg>
+>##### Alternative/CLI install of AdoptOpenJDK 11
+>
+>You can also install adoptopenjdk11 using either `brew` (macOS), `choco` (Windows)
+(see the section on `gradle` and `git` for more informaiton on `brew` and `choco`)
+or `yum` or `apt` (Linux):
+>
+>###### alternative for MacOS and Homebrew
+>```
+>brew tap adoptopenjdk/openjdk
+>brew cask install adoptopenjdk11
+>```
+>
+>###### alternative for Windows and Chocolatey
+>```
+>choco install adoptopenjdk11
+>```
+>
+>###### alternative for Linux with yum/apt
+>
+>see <https://adoptopenjdk.net/installation.html#linux-pkg>
### gradle and git
-You should be able to install the latest (or close to the latest) versions of gradle and git using your OS package manager.
+You should be able to install the latest (or sufficiently recent) versions of gradle and git using your OS package manager.
#### MacOS
we recommend using `brew`, which can be installed following the instructions at <https://brew.sh/>.
brew install gradle git
```
-or
+or if you aready have them installed but need to upgrade the version:
```bash
brew upgrade gradle git
```
-if you already have them installed but need to upgrade the version.
-
#### Windows
we suggest using the **Chocolatey** package manager. See install instructions at <https://chocolatey.org/>, and you will just need
### What's in the source tree?
-Within the `jalview` folder:
-
-| dir/ file | contains|
-|------------|---------|
-| `bin/` | used by eclipse for compiled classes
-| `build/` | the gradle build dir
-| `classes/` | contains the compiled Java classes for the Jalview application
-| `dist/` | assembled `.jar` files needed to run Jalview application
-| `examples/`| example input files usable by Jalview
-| `getdown/` | the libraries used by the Javliew launcher (getdown)
-| `getdown/src/` | our modified source for `getdown`
-| `getdown/website/` | the assembled "download" folder used by getdown for downloads/upgrades
-| `getdown/files/` | the minimal fileset to launch the Jalview launcher, which can then download the rest of the Jalview application
-| `j8lib/` | libraries needed to run Jalview under Java 1.8
-| `j11lib/` | libraries needed to run Jalivew under Java 11
-| `resource/`| non-java resources used in the Jalview application
-| `src/` | the Jalview application source `.java` files
-| `test/` | Test class source files
-| `utils/` | helper applications used in the build process
-| `utils/install4j/` | files used by the packaging tool, install4j
-| `build.gradle` | the build file used by gradle
-| `gradle.properties` | configurable properties for the build process
+Jalview is a mature product with its codebase going back many years. As such it doesn't
+have a folder structure that most new gradle projects would have, so you might not
+find everything in the place you might expect. Here's a brief description of what
+you might find in the main folders under the `jalview` tree.
+
+Within the `jalview` folder you will find (of possible interest):
+
+ dir/ or file | contains
+---------------------|----------------------------------------------------------------------------------------------------------------
+ `bin/` | used by eclipse for compiled classes -- no need to touch this
+ `build/` | the gradle build dir
+ `classes/` | contains the compiled Java classes for the Jalview application
+ `dist/` | assembled `.jar` files needed to run Jalview application
+ `examples/` | example input files usable by Jalview
+ `getdown/` | the libraries used by the Javliew launcher (getdown)
+ `getdown/src/` | our modified source for `getdown`
+ `getdown/website/` | the assembled "download" folder used by getdown for downloads/upgrades
+ `getdown/files/` | the minimal fileset to launch the Jalview launcher, which can then download the rest of the Jalview application
+ `help/` | the help documents
+ `j8lib/` | libraries needed to run Jalview under Java 1.8
+ `j11lib/` | libraries needed to run Jalivew under Java 11
+ `resource/` | non-java resources used in the Jalview application
+ `src/` | the Jalview application source `.java` files
+ `test/` | Test class source files
+ `utils/` | helper applications used in the build process
+ `utils/install4j/` | files used by the packaging tool, install4j
+ `build.gradle` | the build file used by gradle
+ `gradle.properties` | configurable properties for the build process
Note that you need a Java 11 JDK to compile Jalview whether your target build is Java 1.8 or Java 11.
```
in the `gradle.properties` file.
-> *You may want to see some of the properties you can easily change at the end of this document.*
+> *You may want to see some of the other properties you can change at the end of this document.*
### Minimal Jalview Build
classpath argument wildcard interpreted by `java`, **not** a shell expansion wildcard interpreted
by the shell.*
-Note that `jalview.bin.Launcher` is a simplified launch class that re-launches `jalview.bin.Jalview`
-with the same classpath and arguments, but with an automatically determined `-Xmx...`
-memory setting.
+Note that `jalview.bin.Launcher` is a simplified launcher class that re-launches `jalview.bin.Jalview`
+with the same JRE (*not* the same JVM instance), classpath and arguments, but with an automatically determined `-Xmx...`
+memory setting if one hasn't been provided.
### Jalview in a Jar File
### Single *shadow* Jar File
-The shadow jar file is a single `.jar` that contains all required classes -- from `jalview.jar`
+The shadow jar file is a single `.jar` that contains all required classes and resources from `jalview.jar`
and all of the supporting libraries in `j11lib/*.jar` merged into one `.jar` archive
file. A default launching class (`MAIN-CLASS: jalview.bin.Launcher`) is specified in the `.jar`
manifest file (`META/MANIFEST.MF`) so a start class doesn't need to be specified.
unzip) as a `-jar` argument so you may find you can launch `jalview-all-11.jar`
just by double-clicking on it)!
-> The shadow jar file represents probably the simplest way to distribute the Jalview application, to machines that already have a Java 11 installed,
+> The `shadowJar` task is not a requirement for any other task, so to build the shadow
+jar file you must specify the `shadowJar` task.
+
+> The shadow jar file represents probably the simplest way to distribute the Jalview application to machines that already have a Java 11 installed,
although without the many and compelling benefits of the `getdown` launcher.
>
>```bash
>cd getdown/src/getdown
->mvn packages
+>mvn clean package -Dgetdown.host.whitelist="jalview.org,*.jalview.org"
>```
> and you will find the required `.jar` files in `core/target/gradle-core-XXX.jar`
-and `launcher/target/gradle-launcher-XXX.jar`. The `gradle-core.jar` should be copied
-to both the `j11lib` folder to `getdown/lib`, whilst the `gradle-launcher.jar` only
+and `launcher/target/gradle-launcher-XXX.jar`. The `gradle-core.jar` should then be copied
+to all three of the `j8lib`, `j11lib` and `getdown/lib` folders, whilst the `gradle-launcher.jar` only
needs to be copied to `getdown/lib`.
+>
+>The `mvn` command should ideally include the `-Dgetdown.host.whitelist=*.jalview.org` setting.
+ This, and the necessary file copying commands, can be found in `getdown/src/getdown/mvn_cmd`.
To assemble Jalview with `getdown` use the following gradle task:
gradle test
```
-These normally take around 5 - 10 minutes to complete and outputs its results into
-the `tests/` folder.
+These normally take around 5 - 10 minutes to complete and outputs its full results into
+the `tests/` folder. A summary of results should appear in your console.
### Installer packaging with *install4j*
in `build.gradle` file to point to your installation of *install4j* and also to bundled
JREs if you want to bundle those into the installers.
-If you want more details, get in touch on our development mailing list at <http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev>.
+If you want more details, get in touch on our development mailing list <jalview-dev@jalview.org>.
+Sign up at <http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev>.
## Building in Eclipse
>
`TestNG Eclipse Composite P2 Repo - http://beust.com/eclipse-beta`
>
-into the *Work with* box and click on the Add... button.
+into the *Work with* box and click on the *Add...* button.
>
Eclipse might pause for a bit with the word *Pending* in the table below at this point, but it will eventually list TestNG with
a selection box under the *Name* column.
Select *TestNG* and carry on through the
install process to install the TestNG plugin.
-After installing the plugins, it is good to get Java 11 set up in Eclipse as the default JRE.
+After installing the plugins, it is a good to get Java 11 set up in Eclipse as the default JRE.
-To do this go to Preferences (Eclipse->Preferences in macOS, and File->Preferences
-on Windows or Linux) and find
+To do this go to Preferences (Eclipse->Preferences in macOS, File->Preferences
+on Windows or Window->Preferences on Linux) and find
Java -> Installed JREs
and then click on the *Next >* button.
In the following options, it is the *Project Root Directory* you should set to be the
-`jalview` folder that git downloaded. Then you can click on the *Finish* button.
\ No newline at end of file
+`jalview` folder that git downloaded. Then you can click on the *Finish* button.
+
+
+## Gradle properties
+
+There are a lot of properties configured in `gradle.properties` which we strongly recommend
+being left as they are unless you have a specific problem with the build process.
+
+There are a few gradle properties you might want to set on the command line with the
+`-P` flag when building a version of Jalview with specific requirements:
+
+#### `JAVA_VERSION`
+This changes the *target* java bytecode version
+> NOTE that you will need to use a Java 11 (or greater) JDK Java compiler to build
+Jalview for any byte-code target version.
+
+Valid values are `11` and `1.8`.
+
+e.g.
+
+```bash
+gradle shadowJar -PJAVA_VERSION=1.8
+```
+
+When using `-PJAVA_VERSION=1.8` the libraries from `j8lib` (instead of `j11lib`) will be used in the compile
+and runtime classpath and also used in the `makeDist` build step. Where a Java version of `11` is used in folder and file names, it will
+instead use `1.8`. Also if you are building installer packages with *install4j* the
+package builder will look for JRE 1.8 bundles to package in the installers.
+
+> Note that continued development of Jalview will assume a Java 11+ runtime environment,
+the 2.11.0 release will run under a Java 1.8 JRE with a few minor features disabled.
+
+#### `CHANNEL`
+This changes the `appbase` setting in `getdown.txt` (`appbase` is where the getdown launcher
+looks to see if there's an updated file) to point to a particular Jalview
+channel. Expected values are `FILE`, `STABLE`, `DEVELOPMENT`, or a specific version
+of Jalview like `2.11` or `2.10.5`.
+
+A value of `FILE` behaves differently to the other expected values and will use a local
+file-system scheme URI instead of a Jalview release channel. This `file:` scheme URI
+uses an absolute path to the `getdown/website/<JAVA_VERSION>`
+
+On a regular development machine, this property will default to `LOCAL`.
+
+e.g.
+```bash
+gradle getdown -PCHANNEL=DEVELOPMENT
+```
+
+#### `MEDIA_TYPES`
+If you are building *install4j* installers (requires *install4j* to be installed) then this property specifies a comma-separated
+list of media types (i.e. platform specific installers) *install4j* should actually build.
+
+Currently the valid values are
+`linuxDeb`,
+`linuxRPM`,
+`macosArchive`,
+`unixArchive`,
+`unixInstaller`,
+`windows`
+
+The default value is all of them.
+
+e.g.
+```bash
+gradle installers -PJAVA_VERSION=1.8 -PMEDA_TYPE=macosArchive
+```
+
+To get an up-to-date list of possible values, you can run
+
+```bash
+perl -n -e 'm/^\s*<(\w+)[^>]*\bmediaFileName=/ && print "$1\n";' utils/install4j/install4j_template.install4j | sort -u
+```
+in the `jalview` root folder.
\ No newline at end of file
git://source.jalview.org / jalview.git / commitdiff