X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=doc%2Fbuilding.md;h=0453c23f3b7b962747f6f5f86724e85130292875;hb=e3c8595c4af05816fa7bf0859c052a97e3b875ea;hp=b5d8114f00b6ec56143c0a836f2ba4a3c74842c1;hpb=32b479a4470b0b331f805843981415a7130c8b8e;p=jalview.git diff --git a/doc/building.md b/doc/building.md index b5d8114..0453c23 100644 --- a/doc/building.md +++ b/doc/building.md @@ -1,5 +1,24 @@ # Building Jalview from Source +## tl;dr + +``` +# 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 +``` + + ## 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. @@ -9,7 +28,7 @@ The method here is described in terms of using a command line. You can easily d * 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*). +We recommend obtaining an OpenJDK JDK 11 (since 11 is the long term support release) 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. @@ -41,7 +60,7 @@ run ``` ##### for RPM-based distributions (e.g. Fedora, CentOS, RedHat) -run (probably) +run ``` sudo yum install gradle git @@ -93,4 +112,4 @@ in `j8lib` for Java 1.8 runtime and `j11lib` for Java 11 runtime. -and then you can build the Jalview jar file using gradle. \ No newline at end of file +and then you can build the Jalview jar file using gradle.