Mercurial > louis > kiibohd-kll
changeset 26:07f27f57642f
Converting README to markdown
- Also added some basic usage scenarios
author | Jacob Alexander <haata@kiibohd.com> |
---|---|
date | Mon, 16 Feb 2015 13:46:29 -0800 |
parents | b3f267e61a0f |
children | fabcd3621d25 |
files | README README.markdown |
diffstat | 2 files changed, 38 insertions(+), 28 deletions(-) [+] |
line wrap: on
line diff
--- a/README Mon Feb 16 13:29:26 2015 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ -kll - keyboard layout language -============================== - -KLL Compiler - -Most current version of the KLL spec: https://www.writelatex.com/read/zzqbdwqjfwwf -Or visit http://kiibohd.com - -Uses funcparserlib: https://code.google.com/p/funcparserlib/ - - -Usage ------ - -TODO - - -New Patches/Features/Backends ------------------------------ - -Completely welcome :D - - -Spec Additions/Fixes --------------------- - -Contact HaaTa via IRC (#geekhack@irc.freenode.net or #deskthority). -Or by email -> haata@kiibohd.com
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.markdown Mon Feb 16 13:46:29 2015 -0800 @@ -0,0 +1,38 @@ +kll - keyboard layout language +============================== + +KLL Compiler +------------ + +Most current version of the [KLL Spec](https://www.writelatex.com/read/zzqbdwqjfwwf). +Or visit [kiibohd.com](http://kiibohd.com) + +Uses [funcparserlib](https://code.google.com/p/funcparserlib/) + + +Usage +----- + +### General Usage +```kll.py <kll files> +``` + +### Kiibohd Controller Usage +```kll.py <basemap kll files> --default <default layer kll files> --partial <partial layer 1 kll files> --partial <partial layer 2 kll files> --backend kiibohd --template templates/kiibohdKeymap.h --output generatedKeymap.h --defines-template templates/kiibohdDefs.h --defines-output kll_defs.h +``` + +See `kll.py --help` for the most up to date documentation + + +Patches/Features/Backends +------------------------- + +Completely welcome :D + + +Spec Additions/Fixes +-------------------- + +Contact HaaTa via IRC (#geekhack@irc.freenode.net or #deskthority). +Or by email -> haata@kiibohd.com +