di0ib/controller
Archived
1
0
Fork 0
Code Releases Activity
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
d3eaa7a798
controller/README.markdown

88 lines
2.0 KiB
Markdown
Raw Normal View History

Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
The Kiibohd Controller
======================
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
This is the main Kiibohd Firmware.
In general, this should be the **only** git repo you need to clone.
The [KLL](https://github.com/kiibohd/kll) git repo is automatically cloned during the build process.
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
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.
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Official Keyboards
------------------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
* MD1 (Infinity Keyboard 2014/10/15)
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
The Kiibohd firmware supports a lot of other keyboards, but these are more obscure/custom/lesser known.
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Compilation
-----------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Compilation is possible and tested on Windows/Linux/Mac.
Linux is the easiest using this [VM](https://s3.amazonaws.com/configurator-assets/ArchLinux_kiibohd_2015-02-13.tar.gz).
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
For most people refer [here](https://github.com/kiibohd/controller/tree/master/Keyboards).
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
For the full compilation details, please refer to the [wiki](https://github.com/kiibohd/controller/wiki).
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Supported Microcontrollers
--------------------------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
* Teensy 2.0 (Partial)
* Teensy 2.0++
* Teesny 3.0
* Teensy 3.1
* mk20dx128vlf5
* mk20dx256vlh7
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Adding support for more microcontrollers is possible.
Some considerations for minimum specs:
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
* ~8 kB of SRAM
* ~25 kB of Flash
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
It's possible to port chips with lower specs, but will be more effort and have fewer features.
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Contributions
-------------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Contributions welcome!
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
* Bug reports
* Documentation and Wiki editing
* Patches (including new features)
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Licensing
---------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Licensing is done on a per-file basis.
Some of the source code is from [PJRC/Teensy](http://pjrc.com), other source code is from the [McHck Project](https://mchck.org).
Code written specifically for the Kiibohd Controller use the following licenses:
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
* MIT
* GPLv3
* Public Domain
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
Contact
-------
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
If you really need to get a hold of HaaTa, email is best: `haata@kiibohd.com`
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Updating the README to be of a more reasonable length.
2015-03-16 04:37:57 +00:00
IRC is likely faster though.
`#geekhack@irc.freenode.net`
`#deskthority@irc.freenode.net`
Convert README to Markdown format. This makes it render nicely on GitHub's website, as well as having a consistent plain-text format that should be familiar to many.
2015-02-12 06:22:12 +00:00
Copy Permalink