Clarified instructions for contributing keymaps.

This commit is contained in:
Jeff Zohrab 2016-02-12 08:21:13 -05:00
parent 91031728a3
commit 6cb6a2d892
2 changed files with 9 additions and 2 deletions

4
TODO
View File

@ -1,5 +1,9 @@
-> Add automated testing scripts to verify behaviour and operation
-> Add automated smoke test of keymaps (ensure they can be parsed, at least),
and provide and document facility in the code for people to validate
keymaps they create.
-> Clean up imported docs in "./docs", remove redundant docs
-> Add support for sending logs via mail

View File

@ -18,8 +18,11 @@ You can easily create keymaps for your layout by taking one example
and then modifying it with the help of a keyboard layout tool (e.g.,
see the following [example layout tool from
Microsoft](http://msdn.microsoft.com/en-us/goglobal/bb964651.aspx)).
If you create a keymap, please upload it as a [new
issue](https://github.com/kernc/logkeys/issues).
If you create a keymap, please submit a Pull Request to the master
branch of this repo (preferred), or upload it as a [new
issue](https://github.com/kernc/logkeys/issues). Please ensure the
filename has name and locale, if appropriate (e.g., "de_CH.map" vs
just "de.map").
## Format