system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-10-15 04:13:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Keymaps are nice, document them!

Browse source 
fixup! Meta+Documentation: Fix sync-local.sh support, document keymaps
This commit is contained in:
Ben Wiederhake 2021-01-30 20:09:42 +01:00 committed by Andreas Kling
parent cbee0c26e1
commit 52fff644d5
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
Documentation/BuildInstructions.md
View file

@ -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.