doc/building.html

   1 <html><head>
   2                 <meta charset='utf-8'>
   3                 <meta http-equiv='x-ua-compatible' content='IE=edge'/>
   4                 <meta name="viewport" content="width=device-width,initial-scale=1.0">
   5                 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css">
   6                 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
   7                 <script>hljs.initHighlightingOnLoad();</script>
   8 <style media="screen" type="text/css">
   9 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}
  10 </style>
  11 </head><body>
  12 <h1 id="building-jalview-from-source">Building Jalview from Source</h1>
  13 <h2 id="what-you-will-need">What you will need</h2>
  14 <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>
  15 <ul>
  16 <li>Java 11 compliant JDK</li>
  17 <li>gradle 5.1 or above</li>
  18 <li>git</li>
  19 </ul>
  20 <h3 id="java-11-jdk">Java 11 JDK</h3>
  21 <p>We recommend obtaining an OpenJDK JDK 11 from AdoptOpenJDK: <a href="https://adoptopenjdk.net/?variant=openjdk11&amp;jvmVariant=hotspot" class="uri">https://adoptopenjdk.net/?variant=openjdk11&amp;jvmVariant=hotspot</a>, either the <em>Installer</em> or <code>.zip</code>/<code>.tar.gz</code> variants whichever you prefer (if you&rsquo;re not sure, choose the <em>Installer</em>).</p>
  22 <h3 id="gradle-and-git"><code>gradle</code> and <code>git</code></h3>
  23 <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>
  24 <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>
  25 <p>For <strong>linux</strong> this will depend on which distribution you&rsquo;re using. For <em>debian</em> based distributions (e.g.&nbsp;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&rsquo;ll probably be able to work it out!</p>
  26 <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>
  27 <h2 id="section"></h2>
  28
  29 </body></html>