Skip to content
Permalink
Browse files

Merge pull request #146 from jzohrab/doc_fixes

Doc fixes
  • Loading branch information...
kernc committed Feb 12, 2016
2 parents 5e7fa2b + 6cb6a2d commit 22ff08f4bcda0a0f5bcc1a60a88acf51383fff64
Showing with 15 additions and 3 deletions.
  1. +2 −2 README.md
  2. +4 −0 TODO
  3. +9 −1 docs/Keymaps.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
4 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
@@ -14,7 +14,15 @@ 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 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

0 comments on commit 22ff08f

Please sign in to comment.
You can’t perform that action at this time.