From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Sat, 18 Mar 2017 08:07:02 +0000 (+0100)
Subject: Add instructions for compiling Sone
X-Git-Tag: 0.9.7^2~288
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=30752040363cd68bf4fc8bbc7427ec7539e21e9e;p=Sone.git

Add instructions for compiling Sone
---

diff --git a/README.md b/README.md
index c8e8a00..1f7eef3 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,14 @@
 
 Sone aims to provide social network functionality for [Freenet](https://freenetproject.org/) (also here [on GitHub](https://github.com/freenet/)).
 
+## Compiling
+
+Sone’s build process is handled by [Gradle](https://gradle.org/). Just use the Gradle wrapper that comes with Sone:
+
+    # ./gradlew clean build fatJar
+
+This will resolve Sone’s dependencies, compile Sone, run all the tests, and put the file `sone-jar-with-dependencies.jar` into the `build/libs` directory. This is the file that you can load from Freenet’s plugin manager to run Sone.
+
 ## Installing
 
 ### Prerequisites