From 5e7bd11046fbc7d747913906a5147244bae82394 Mon Sep 17 00:00:00 2001 From: Herman Sletmoen Date: Fri, 20 Aug 2021 19:08:36 +0200 Subject: [PATCH] Corrected and improved README --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 52f649e..1404e6d 100644 --- a/README.md +++ b/README.md @@ -46,36 +46,35 @@ A full documentation on how to set this up is available at ### Build and Install -To compile BRouter including the BRouter Android app, add a file 'local.properties' to main folder with your Android path +To compile the BRouter Android app, the Android SDK path must first be set in a file called `local.properties` in the main folder: ``` sdk.dir= ``` -and use +Build BRouter with the Android app (if Android SDK path is set): ``` -gradlew clean build +./gradlew clean build ``` -If you only want to compile BRouter and the server part (skipping the Android -app), use +Build BRouter without the Android app: ``` -gradlew clean build -x :brouter-routing-app:build - -``` -Then build a jar for server and map creator with all dependent classes - -``` -gradlew farJar +./gradlew clean build -x :brouter-routing-app:build ``` -Build a zip file for distribution. Contains readmes, profiles, apk and jar +Build JAR file for server and map creator with all dependent classes: ``` -gradlew distZip +./gradlew clean build fatJar # places JAR file in brouter-server/build/libs/ +``` + +Build ZIP file for distribution with readmes, profiles, APK and JAR: + +``` +./gradlew distZip # places ZIP file in brouter-server/build/distributions/ ```