From 5ce4f11a0b3d1cdd7c421f53ec2483fe349ca52f Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Sat, 1 Oct 2022 21:25:51 +0200 Subject: [PATCH] Explain how to update the submodules --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2dc670..1318b91 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,18 @@ For an example configuration file, see [unl0kr.conf]. ## Building & running -For development and testing you can run the app in a VT. Unless your user account has special privileges, `sudo` will be needed to access input device files. +Some of unl0kr's dependencies are included as git submodules in this repository. You can clone the repository and initialise the submodules with + +``` +$ git clone https://gitlab.com/cherrypicker/unl0kr.git +$ cd unl0kr +$ git submodule init +$ git submodule update +``` + +When pulling changes from the remote later, either use `git pull --recurse-submodules` or manually run `git submodule update` as needed after pulling. + +Once you have the sources, you can build the app and run it in a VT. Unless your user account has special privileges, `sudo` will be needed to access input device files. ``` $ meson _build