From: Jacob Alexander <haata@kiibohd.com>
Date: Mon, 16 Feb 2015 21:46:29 +0000 (-0800)
Subject: Converting README to markdown
X-Git-Url: https://git.donarmstrong.com/?p=kiibohd-kll.git;a=commitdiff_plain;h=ef4686292d8ae2c8d1985f8f7513ff7321ce0add

Converting README to markdown

- Also added some basic usage scenarios
---

diff --git a/README b/README
deleted file mode 100644
index 9a04997..0000000
--- a/README
+++ /dev/null
@@ -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
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..a07c2c0
--- /dev/null
+++ b/README.markdown
@@ -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
+