Documentation: Keymaps are nice, document them!

fixup! Meta+Documentation: Fix sync-local.sh support, document keymaps
Author: https://github.com/BenWiederhake Commit: https://github.com/SerenityOS/serenity/commit/52fff644d5b Pull-request: https://github.com/SerenityOS/serenity/pull/5192 Reviewed-by: https://github.com/awesomekling Reviewed-by: https://github.com/bcoles Reviewed-by: https://github.com/emanuele6 Reviewed-by: https://github.com/linusg
2025-01-23 09:46:04 -05:00 · 2021-01-30 20:09:42 +01:00 · 2021-01-30 20:09:42 +01:00 · 52fff644d5 · 2024-07-18 22:39:57 +09:00
commit 52fff644d5
parent cbee0c26e1
1 changed files with 20 additions and 0 deletions
--- a/Documentation/BuildInstructions.md
+++ b/Documentation/BuildInstructions.md
@ -169,3 +169,23 @@ Later on, when you `git pull` to get the latest changes, there's (usually) no ne

 #### Ports
 To add a package from the ports collection to Serenity, for example curl, go into `Ports/curl/` and run **./package.sh**. The sourcecode for the package will be downloaded and the package will be built. After that, run **make image** from the `Build/` directory to update the disk image. The next time you start Serenity with **make run**, `curl` will be available.
+
+#### Keymap
+
+Create a file with the exact name `sync-local.sh` in the project root (the same directory as `.clang-format`), with content like this:
+
+```
+#!/bin/sh
+
+set -e
+
+cat << 'EOF' >> mnt/etc/SystemServer.ini
+
+[keymap]
+Executable=/bin/keymap
+Arguments=de
+User=anon
+EOF
+```
+
+This will configure your keymap to German (`de`) instead of US English. See [`Base/res/keymaps/`](../Base/res/keymaps/) for a full list.