Mercurial > louis > kiibohd-controller

annotate README.markdown @ 313:a2df35fa4f0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating the README to be of a more reasonable length.
author Jacob Alexander <haata@kiibohd.com>
date Sun, 15 Mar 2015 21:37:57 -0700
parents 4f47971c45c2
children e4be15c39cce
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
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
15 * MD1 (Infinity Keyboard 2014/10/15)
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
16
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
17
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
18 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
19
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
20
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
21
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
22 Compilation
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
23 -----------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
24
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
25 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
26 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
27
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
28 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
29
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
30 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
31
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
32
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
33
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
34 Supported Microcontrollers
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
35 --------------------------
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
36
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
37 * Teensy 2.0 (Partial)
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
38 * Teensy 2.0++
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
39 * Teesny 3.0
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
40 * Teensy 3.1
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
41 * mk20dx128vlf5
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
42 * mk20dx256vlh7
289
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
43
8c9e4b8a1999 Adding keymap configuration section to the README.
Jacob Alexander <haata@kiibohd.com>
parents: 286
diff changeset
44
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
45 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
46 Some considerations for minimum specs:
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
47
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
48 * ~8 kB of SRAM
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
49 * ~25 kB of Flash
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
50
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
51 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
52
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
53
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
54
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
55 Contributions
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
56 -------------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
57
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
58 Contributions welcome!
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 * Bug reports
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
61 * Documentation and Wiki editing
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
62 * Patches (including new features)
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
63
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
64
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
65
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
66 Licensing
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
67 ---------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
68
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
69 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
70 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
71 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
72
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
73 * MIT
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
74 * GPLv3
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
75 * Public Domain
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
76
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
77
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
78
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
79 Contact
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
80 -------
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
81
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
82 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
83
313
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
84 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
85 `#geekhack@irc.freenode.net`
a2df35fa4f0b Updating the README to be of a more reasonable length.
Jacob Alexander <haata@kiibohd.com>
parents: 309
diff changeset
86 `#deskthority@irc.freenode.net`
277
aabd00e4b17b Convert README to Markdown format.
Mike Cooper <mythmon@gmail.com>
parents:
diff changeset
87