From ab6c925a9c6eb101303425b3ac36e0dbe1d91de5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20K=C3=BCrten?= <sebastian@mobanisto.de>
Date: Fri, 14 Oct 2022 16:39:44 +0200
Subject: [PATCH] Update instructions on how to build and run briar-headless
---
briar-headless/README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/briar-headless/README.md b/briar-headless/README.md
index 4afcbdb700..f7aed1d71d 100644
--- a/briar-headless/README.md
+++ b/briar-headless/README.md
@@ -9,24 +9,25 @@ or to develop your own user interface for it.
The REST API peer comes as a `jar` file
and needs a Java Runtime Environment (JRE) that supports at least Java 8.
-It currently works only on GNU/Linux operating systems.
+It currently works only on GNU/Linux operating systems and on Windows.
To build the `jar` file, you need to specify the combination of architecture and platform:
$ ./gradlew --configure-on-demand briar-headless:x86LinuxJar
$ ./gradlew --configure-on-demand briar-headless:aarch64LinuxJar
$ ./gradlew --configure-on-demand briar-headless:armhfLinuxJar
+ $ ./gradlew --configure-on-demand briar-headless:windowsJar
You can start the peer (and its API server) like this:
- $ java -jar briar-headless/build/libs/briar-headless.jar
+ $ java -jar briar-headless/build/libs/briar-headless-<platform>-<architecture>.jar
It is possible to put parameters at the end.
Try `--help` for a list of options.
On the first start, it will ask you to create a user account:
- $ java -jar briar-headless.jar
+ $ java -jar briar-headless-linux-x86_64.jar
No account found. Let's create one!
Nickname: testuser
--
GitLab