From 29b93b8558f93caeb81049800cd3747a93ad7f5d Mon Sep 17 00:00:00 2001 From: ialokim <ialokim@mailbox.org> Date: Thu, 9 Sep 2021 11:17:44 +0200 Subject: [PATCH] add instructions to download source code with git submodules --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6cb277902a..0d4d2c4164 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,21 @@ java -jar briar-desktop.jar ## Developers +### Download Source Code + +Briar dependencies are included as [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). +To be able to build Briar Desktop, download the source code and the submodules using + +```shell +git clone --recursive-submodules git@code.briarproject.org:briar/briar-desktop.git +``` + +or + +```shell +git clone --recursive-submodules https://code.briarproject.org/briar/briar-desktop.git +``` + ### Intellij IDEA The easiest and most convenient way to build Briar Desktop is by using -- GitLab