doc/building.md

   1 # Building Jalview from Source
   2
   3 ## What you will need
   4
   5 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.
   6
   7 * Java 11 compliant JDK
   8 * gradle 5.1 or above
   9 * git
  10
  11 ### Java 11 JDK
  12 We recommend obtaining an OpenJDK JDK 11 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*).
  13
  14 ### gradle and git
  15 You should be able to install the latest (or close to the latest) versions of gradle and git using your OS package manager.
  16
  17 For **macOS** we recommend using `brew`, which can be installed following the instructions at <https://brew.sh/>.
  18 After installing `brew`, open a Terminal window and type in (using an Administrator privileged user):
  19
  20 ```
  21 brew install gradle git
  22 ```
  23
  24 or
  25
  26 ```
  27 brew upgrade gradle git
  28 ```
  29
  30 if you already have them installed but need to upgrade the version.
  31
  32 For **linux** this will depend on which distribution you're using.
  33 For *Debian* based distributions (e.g. Mint, Ubuntu, Debian) run
  34
  35 ```
  36  sudo apt-get install gradle git
  37 ```
  38
  39 whilst for RPM-based distributions run (probably)
  40
  41 ```
  42 sudo yum install gradle git
  43 ```
  44
  45 If you have some other version of linux you'll probably be able to work it out!
  46
  47 For **Windows** users, you will likely do well by using the **Chocolatey** package manager.  See install instructions at <https://chocolatey.org/>, and you will just need
  48
  49 ```
  50 choco install gradle git
  51 ```
  52
  53 Alternatively, you could install a real `bash` shell and install both `gradle` and `git` through `apt-get`.
  54 Another alternative would be to install them separately following the instructions at <https://gradle.org/install/>, and for `git` here are a couple of suggestions: Git for Windows <https://gitforwindows.org/> or a real `bash`-shell <https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/> !
  55
  56 ##