doc/building.md

   1 # Building Jalview from Source
   2
   3 ## tl;dr
   4
   5 ```
   6 # download
   7 git clone http://source.jalview.org/git/jalview.git
   8 #compile
   9 cd jalview
  10 gradle getdown
  11 # run
  12 cd getdown/files/11
  13 java -jar gradle-launcher.jar . jalview
  14 ```
  15
  16
  17 ## What you will need
  18
  19 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.
  20
  21 * Java 11 compliant JDK
  22 * gradle 5.1 or above
  23 * git
  24
  25 ### Java 11 JDK
  26 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*).
  27
  28 ### gradle and git
  29 You should be able to install the latest (or close to the latest) versions of gradle and git using your OS package manager.
  30
  31 #### For **macOS**
  32 we recommend using `brew`, which can be installed following the instructions at <https://brew.sh/>.
  33 After installing `brew`, open a Terminal window and type in (using an Administrator privileged user):
  34
  35 ```
  36 brew install gradle git
  37 ```
  38
  39 or
  40
  41 ```
  42 brew upgrade gradle git
  43 ```
  44
  45 if you already have them installed but need to upgrade the version.
  46
  47 #### For **linux**
  48 this will depend on which distribution you're using.
  49
  50 ##### For *Debian* based distributions (e.g. Mint, Ubuntu, Debian)
  51 run
  52
  53 ```
  54  sudo apt-get install gradle git
  55 ```
  56
  57 ##### for RPM-based distributions (e.g. Fedora, CentOS, RedHat)
  58 run (probably)
  59
  60 ```
  61 sudo yum install gradle git
  62 ```
  63
  64 If you have some other version of linux you'll probably be able to work it out!
  65
  66
  67 #### For **Windows**
  68
  69 we suggest using the **Chocolatey** package manager.  See install instructions at <https://chocolatey.org/>, and you will just need
  70
  71 ```
  72 choco install gradle git
  73 ```
  74
  75 Alternatively, you could install a real `bash` shell and install both `gradle` and `git` through `apt-get`.
  76 See <https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/>
  77 for how to install the ubuntu bash shell in Windows 10.
  78
  79 Another alternative would be to install them separately. For `gradle` follow the instructions at <https://gradle.org/install/>, and for `git` here are a couple of suggestions: Git for Windows <https://gitforwindows.org/>.
  80
  81 ## Downloading the Jalview source tree
  82
  83 This can be done with `git`.
  84 On the command line, change directory to where you want to download Jalview's build-tree
  85 top level directory.  Then run
  86
  87 ```
  88 git clone http://source.jalview.org/git/jalview.git
  89 ```
  90
  91 You'll get some progress output and after a minute or two you should have the full
  92 Jalview build-tree in the folder `jalview`.
  93
  94 ## What's in the source tree?
  95
  96 Change directory into the `jalview` folder:
  97
  98 ```
  99 cd jalview
 100 ```
 101 and you'll find most of the Jalview source files under `src`. Some important resource
 102 files can be found under `resources`.  The helper jar libraries can currently be found
 103 in `j8lib` for Java 1.8 runtime and `j11lib` for Java 11 runtime.
 104
 105
 106
 107
 108
 109
 110 and then you can build the Jalview jar file using gradle.