Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
kll/README.markdown
Jacob Alexander d7b7752dc1 Updating Lexer to KLL 0.5c
- Added syntax check unit-test
- Added none emitter (for syntax validation check)
- Added KLL 0.5c example expressions
- Added Travis-CI test for syntax check
- Cleaned up README
2016-10-09 20:02:31 -07:00

49 lines
1.2 KiB
Markdown

kll - keyboard layout language
==============================
[![https://travis-ci.org/kiibohd/kll](https://travis-ci.org/kiibohd/kll.svg?branch=master)](https://travis-ci.org/kiibohd/kll)
[![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/input.club.png)](https://kiwiirc.com/client/irc.freenode.net/#input.club)
## If you're trying to compile keyboard firmware, you want [THIS](https://github.com/kiibohd/controller/)
KLL Compiler
------------
Most current version of the [KLL Spec](https://github.com/kiibohd/kll-spec).
Uses [funcparserlib](https://code.google.com/p/funcparserlib/)
Usage
-----
### General Usage
```bash
kll <kll files>
```
### Kiibohd Controller Usage
```bash
kll.py <misc kll files> --config <config/capability kll files> --base <basemap kll files) --default <default layer kll files> --partial <partial layer 1 kll files> --partial <partial layer 2 kll files>
```
See `kll --help` for the most up to date documentation
Unit Tests
----------
Unit tests can be found in the [tests](tests) directory.
They are run by Travis-CI, but can be useful when testing your own changes.
Remember to add new tests when adding new features/changes.
Patches/Features/Backends
-------------------------
Completely welcome :D