abouttreesummaryrefslogcommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJules Aguillon2024-01-21 16:34:49 +0100
committerJules Aguillon2024-01-21 16:34:49 +0100
commitad7314a01684185f5cf33cc31ef35d1027776a88 (patch)
tree189c2f9c8e085335689dfe30cb907cea5ba5c08e /CONTRIBUTING.md
parentbef29da3dee4aadc1f2c199cea846502e14aca5b (diff)
downloadunexpected-keyboard-ad7314a01684185f5cf33cc31ef35d1027776a88.tar.gz
unexpected-keyboard-ad7314a01684185f5cf33cc31ef35d1027776a88.zip
Move layout definitions into srcs/layouts
This separates the layout definitions from the special layouts (bottom_row, greekmath) and other unrelated files (method, settings). This is also a more intuitive location for layouts and make the resource directory easier to navigate. Under the hood, layouts are copied back into build/generated-resources/xml.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62b2342..596ea64 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -88,14 +88,15 @@ Github secret named `DEBUG_KEYSTORE`.
### Adding a layout
-Layouts are defined in XML, see `res/xml/latn_qwerty_us.xml`.
+Layouts are defined in XML, see `srcs/layouts/latn_qwerty_us.xml`.
An online tool for editing layout files written by @Lixquid is available
[here](https://unexpected-keyboard-layout-editor.lixquid.com/).
Makes sure to specify the `name` attribute like in `latn_qwerty_us.xml`,
otherwise the layout won't be added to the app.
-The layout file must be placed in the `res/xml/` directory and named according to:
+The layout file must be placed in the `srcs/layouts` directory and named
+according to:
- script (`latn` for latin, etc..)
- layout name (eg. the name of a standard)
- country code (or language code if more adequate)