From: Ben Soares Date: Thu, 2 May 2019 11:15:44 +0000 (+0100) Subject: JAL-3248 some progress on prerequesite installation instructions X-Git-Tag: Release_2_11_0~7^2~22 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=125af3bce4d842b04a1387186fafde1225080610;p=jalview.git JAL-3248 some progress on prerequesite installation instructions --- diff --git a/doc/building.html b/doc/building.html new file mode 100644 index 0000000..7114fa3 --- /dev/null +++ b/doc/building.html @@ -0,0 +1,29 @@ + + + + + + + + + +

Building Jalview from Source

What you will need

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.

Java 11 compliant JDK
gradle 5.1 or above
git

Java 11 JDK

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).

`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.

For macOS we recommend using brew, which can be installed following the instructions at https://brew.sh/. After installing brew, open a Terminal window and type in (using an Administrator privileged user): brew install gradle git or brew upgrade gradle git if you already have them installed but need to upgrade the version.

For linux this will depend on which distribution you’re using. For debian based distributions (e.g. Mint, Ubuntu, Debian) run sudo apt-get install gradle git whilst for RPM-based distributions run (probably) sudo yum install gradle git If you have some other version of linux you’ll probably be able to work it out!

For Windows users, you might do well by using the Chocolatey package manager. See install instructions at https://chocolatey.org/, and you will just need choco install gradle git Alternatively, you could install a real bash shell and install both gradle and git through apt-get. 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/ !

+ + \ No newline at end of file diff --git a/doc/building.md b/doc/building.md new file mode 100644 index 0000000..e410469 --- /dev/null +++ b/doc/building.md @@ -0,0 +1,56 @@ +# Building Jalview from Source + +## What you will need + +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. + +* Java 11 compliant JDK +* gradle 5.1 or above +* git + +### Java 11 JDK +We recommend obtaining an OpenJDK JDK 11 from AdoptOpenJDK: , either the *Installer* or `.zip`/`.tar.gz` variants whichever you prefer (if you're not sure, choose the *Installer*). + +### 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. + +For **macOS** we recommend using `brew`, which can be installed following the instructions at . +After installing `brew`, open a Terminal window and type in (using an Administrator privileged user): + +``` +brew install gradle git +``` + +or + +``` +brew upgrade gradle git +``` + +if you already have them installed but need to upgrade the version. + +For **linux** this will depend on which distribution you're using. +For *Debian* based distributions (e.g. Mint, Ubuntu, Debian) run + +``` + sudo apt-get install gradle git +``` + +whilst for RPM-based distributions run (probably) + +``` +sudo yum install gradle git +``` + +If you have some other version of linux you'll probably be able to work it out! + +For **Windows** users, you will likely do well by using the **Chocolatey** package manager. See install instructions at , and you will just need + +``` +choco install gradle git +``` + +Alternatively, you could install a real `bash` shell and install both `gradle` and `git` through `apt-get`. +Another alternative would be to install them separately following the instructions at , and for `git` here are a couple of suggestions: Git for Windows or a real `bash`-shell ! + +## \ No newline at end of file