add build guide (#82)

* add build guide * minor fix * address reviewer feedback * update version requirements * ./gradlew installDist -> ./gradlew build * updating submodule to latest * Fix build verification steps Co-authored-by: Nicolas MASSART <[email protected]> Co-authored-by: chris <[email protected]>
Consensys · May 14, 2021 · 98c66a9 · 98c66a9
1 parent f329033
commit 98c66a9
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 2 deletions.
diff --git a/common b/common
diff --git a/docs/HowTo/Get-started/Build-From-Source.md b/docs/HowTo/Get-started/Build-From-Source.md
@@ -0,0 +1,39 @@
+---
+description: Build Tessera from source
+---
+
+# Build from source
+
+## Prerequisites
+
+- [Java JDK](https://www.oracle.com/java/technologies/javase-downloads.html)
+
+!!! important
+
+    Tessera version 0.10.3 or later requires Java version 11, and Tessera version 0.10.2 or earlier requires Java version 8 or 11.
+
+- [libsodium](https://download.libsodium.org/doc/installation/)
+
+## Clone the Tessera repository
+
+Clone the `ConsenSys/tessera` repository:
+
+``` bash
+git clone https://github.com/ConsenSys/tessera.git
+```
+
+### Build Tessera
+
+After cloning, go to the `tessera` directory.
+
+Build Tessera with the Gradle wrapper `gradlew`, omitting tests as follows:
+
+```bash
+./gradlew build -x test
+```
+
+Verify the installation with the `help` command:
+
+```bash
+java -jar tessera-dist/tessera-app/build/libs/tessera-app-<version>-app.jar help
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -56,7 +56,8 @@ nav:
   - How to:
     - Get started with Tessera:
       - Dependencies: HowTo/Get-started/Dependencies.md
-      - Install Tessera: HowTo/Get-started/DistributionJar.md
+      - Install distribution: HowTo/Get-started/DistributionJar.md
+      - Build from source: HowTo/Get-started/Build-From-Source.md
       - Start Tessera: HowTo/Get-started/Start-Tessera.md
     - Generate keys:
       - Generate keys with Tessera: HowTo/Generate-Keys/Generate-Keys.md