diff options
| author | Jules Aguillon | 2026-02-24 22:50:16 +0100 |
|---|---|---|
| committer | GitHub | 2026-02-24 22:50:16 +0100 |
| commit | 9863dcea9eaa197177552f8621091b3e0858cc76 (patch) | |
| tree | 1453cfaa99be1bed02e46341b327b287ea5a5ffd /CONTRIBUTING.md | |
| parent | a80afa5fbebd023167394cdc3e31fc26790cffaa (diff) | |
| download | unexpected-keyboard-9863dcea9eaa197177552f8621091b3e0858cc76.tar.gz unexpected-keyboard-9863dcea9eaa197177552f8621091b3e0858cc76.zip | |
gradle: Show an error when Git submodules are not initialized (#1188)
* CONTRIBUTING: Document Git submodules
* build: Error during build if the submodules are not initialized
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89943a9..f2f37a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,12 @@ Android Studio is not required. The build dependencies are: Python 3 is required to update generated files but not to build the app. +Make sure the Git submodules are initialized and point to the right revision: + +```sh +git submodule update --init +``` + For Android Studio users, no more setup is needed. For Nix users, the right environment can be obtained with `nix-shell ./shell.nix`. |