diff --git a/TODO b/TODO index 1b8e73a..a68e9fb 100644 --- a/TODO +++ b/TODO @@ -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 diff --git a/docs/Keymaps.md b/docs/Keymaps.md index 3602396..37ad8e5 100644 --- a/docs/Keymaps.md +++ b/docs/Keymaps.md @@ -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