aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: eaa54fd43a27641bb9a92d78302dd137d0b38e66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Introduction
============

A firmware Sketch for the Keyboardio Model 01.  Based algerno's:
https://git.madhouse-project.org/algernon/Model01-Sketch#base-layer


Build
=====

Arduino 1.6.7 or newer is required.  Unfortunately, as of 2019-06-25 the
version found in Debian sid is too old (cf. #780706, #925578, #927329).
Dowload a recent version at https://www.arduino.cc and it unpack to
/usr/local/arduino.

Initialize (or update) submodules:

    ~$ git submodule update --init \
            lib/hardware/keyboardio

    ~$ git -C lib/hardware/keyboardio submodule update --init --recursive \
            "avr/bootloaders/*" \
            "avr/libraries/Kaleidoscope" \
            "avr/libraries/Kaleidoscope-HIDAdaptor-KeyboardioHID" \
            "avr/libraries/Keyboardio*" \
            "build-tools"

    ~$ make


Flash firmware
==============

    ~$ make flash

Press down the 'prog' key while the board is rebooting.  You can release
it once it glows red.