X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=README.md;h=31ed99ef27dd022c1826d7ba2ca6a95d4b378462;hp=c8e8a0077fc40ac15ebab75d714b93e558654070;hb=4c5ae97880b63e18f3cd3f0764c3ea4ceb00f712;hpb=10d1b486c2e2f0ad652e0988a097f8f906e6507c diff --git a/README.md b/README.md index c8e8a00..31ed99e 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,21 @@ 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 For Sone to work you will need a running Freenet node, of course. You will also need the Web of Trust plugin from the official plugins listed on your node’s plugin manager page (*Configuration → Plugins* in the menu). -If you already have a web of trust identity, you can skip the next section. - -You will also need to create an identity in the web of trust. Select *Community* from the menu, choose “Generate” and follow the instructions on-screen until your identity has been created. +You will also need a web of trust identity to use Sone. If you do not already have a web of trust identity, select *Community* from the menu, choose “Generate” and follow the instructions on-screen until your identity has been created. ### Loading/Installing