From 8263a1fee4b34163233d9aac295ebd9b0264a6a3 Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Fri, 12 Feb 2016 08:16:47 -0500 Subject: [PATCH 1/3] Wrapped long line only, no content changes. --- docs/Keymaps.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/Keymaps.md b/docs/Keymaps.md index f1b9865..3602396 100644 --- a/docs/Keymaps.md +++ b/docs/Keymaps.md @@ -14,7 +14,12 @@ Be aware that using the keymap that matches your keyboard layout doesn't necessa ## Creating keymaps -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). +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). ## Format From 91031728a32b3b55a5f40e5c04fdaa6963fbd26c Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Fri, 12 Feb 2016 08:20:50 -0500 Subject: [PATCH 2/3] Fixed markdown only. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92a0988..99fd736 100644 --- a/README.md +++ b/README.md @@ -128,8 +128,8 @@ Further information Read the man page. Please read the whole man page. Thanks. :-) -Refer to troubleshooting and FAQ sections in (the -docs)[./docs/Documentation.md], for currently known issues, ways to +Refer to troubleshooting and FAQ sections in [the +docs](./docs/Documentation.md), for currently known issues, ways to resolve them, and any other information. Report any bugs and request reasonable features on the [issues From 6cb6a2d8924f64bb721a04e85cc82ee641157952 Mon Sep 17 00:00:00 2001 From: Jeff Zohrab Date: Fri, 12 Feb 2016 08:21:13 -0500 Subject: [PATCH 3/3] Clarified instructions for contributing keymaps. --- TODO | 4 ++++ docs/Keymaps.md | 7 +++++-- 2 files changed, 9 insertions(+), 2 deletions(-) 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