Mercurial > louis > kiibohd-controller

annotate README.markdown @ 412:e7a3be42ae1e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Debug code for interconnect cable debugging
author Jacob Alexander <haata@kiibohd.com>
date Sat, 20 Feb 2016 13:27:49 -0800
parents f2c9dd76a1fb
children 0a402c8e362a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
1 The Kiibohd Controller
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
2 ======================
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
3
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
4 This is the main Kiibohd Firmware.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
5 In general, this should be the **only** git repo you need to clone.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
6 The [KLL](https://github.com/kiibohd/kll) git repo is automatically cloned during the build process.
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
7
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
8 Please refer to the [KLL](https://github.com/kiibohd/kll) repo or [kiibohd.com](http://kiibohd.com) for details on the KLL (Keyboard Layout Language) Spec.
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
9
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
10
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
11
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
12 Official Keyboards
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
13 ------------------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
14
362
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents: 313
diff changeset
15 * MD1 (Infinity Keyboard/IC60 2014/10/15)
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents: 313
diff changeset
16 * MDErgo1 (Infinity Ergodox /ICED 2015/03/31)
e4be15c39cce Adding initial WhiteFox support.
Jacob Alexander <haata@kiibohd.com>
parents: 313
diff changeset
17 * WhiteFox (Soon to be released?)
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
18
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
19
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
20 The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
21
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
22
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
23
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
24 Compilation
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
25 -----------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
26
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
27 Compilation is possible and tested on Windows/Linux/Mac.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
28 Linux is the easiest using this [VM](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz).
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
29
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
30 For most people refer [here](https://github.com/kiibohd/controller/tree/master/Keyboards).
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
31
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
32 For the full compilation details, please refer to the [wiki](https://github.com/kiibohd/controller/wiki).
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
33
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
34
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
35
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
36 Supported Microcontrollers
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
37 --------------------------
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
38
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
39 * Teensy 2.0 (Partial)
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
40 * Teensy 2.0++
387
a11bb1148eaf Fixed typo
Jan van Haarst <jan@vanhaarst.net>
parents: 362
diff changeset
41 * Teensy 3.0
405
f2c9dd76a1fb Updating README for Teensy 3.2 support
Jacob Alexander <jacob.alexander@virtualinstruments.com>
parents: 387
diff changeset
42 * Teensy 3.1/3.2
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
43 * mk20dx128vlf5
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
44 * mk20dx256vlh7
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
45
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
46
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
47 Adding support for more microcontrollers is possible.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
48 Some considerations for minimum specs:
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
49
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
50 * ~8 kB of SRAM
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
51 * ~25 kB of Flash
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
52
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
53 It's possible to port chips with lower specs, but will be more effort and have fewer features.
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
54
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
55
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
56
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
57 Contributions
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
58 -------------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
59
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
60 Contributions welcome!
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
61
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
62 * Bug reports
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
63 * Documentation and Wiki editing
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
64 * Patches (including new features)
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
65
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
66
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
67
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
68 Licensing
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
69 ---------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
70
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
71 Licensing is done on a per-file basis.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
72 Some of the source code is from [PJRC/Teensy](http://pjrc.com), other source code is from the [McHck Project](https://mchck.org).
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
73 Code written specifically for the Kiibohd Controller use the following licenses:
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
74
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
75 * MIT
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
76 * GPLv3
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
77 * Public Domain
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
78
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
79
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
80
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
81 Contact
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
82 -------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
83
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
84 If you really need to get a hold of HaaTa, email is best: `haata@kiibohd.com`
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
85
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
86 IRC is likely faster though.
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
87 `#geekhack@irc.freenode.net`
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
88 `#deskthority@irc.freenode.net`
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
89