From 798dd4dfb2bbb0d1b8ac9a493b998691431b8bfa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Wed, 3 Jan 2024 18:16:43 +0000 Subject: [PATCH] README: Add build instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In addition to https://github.com/contiki-ng/cooja/issues/1387 Signed-off-by: Marek Küthe --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 63aaa51044..4ff1197066 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ Cooja is an open source network simulator. - ## MSPSim support for the Cooja Simulator MSPSim is a Java-based instruction level emulator of the MSP430 series @@ -10,3 +9,16 @@ microprocessor and emulation of some sensor networking platforms. It is used by Cooja to emulate MSP430 based platforms and is part of the Cooja source code. +## Building + +To build Cooja, you can run `./gradlew build`. Cooja is then provided in `build/libs/cooja.jar` as a JAR file. The dependencies are located in `build/libs/lib`. + +To build Cooja easily executable and with all dependencies, you can use the following command: +``` +./gradlew distTar +``` +or +``` +./gradlew distZip +``` +This command creates a compressed folder in `build/distributions/` which contains both the JAR file and a platform-independent script for execution.