aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 0dd8f9bcecbf3d60e1e9b6a3ebbf6b1d8f33ba7a (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
hktool
======

Simple HalfKay loader / rebooter.

Reasoning
---------

hktool was created as a basic replacement for teensy-loader-cli.
teensy-loader-cli was a fundamentally messy and confusing implementation of the
HalfKay protocol used by the boot loader chips / code used in Teensy devices.

This reimplementation is a libusb only rewrite of the old loader with a much
simplified command line interface and a design which aims for easy end user
extensibility to support future Teensy devices. This means that if PJRC release
a new teensy device based on a new chip, it should be possible (unless the
HalfKay protocol changes considerably) to simply add a new definition for the
device in the form of a simple plain text file.

Dependencies
------------

 - (make) GNU Make (or compatible)
 - libusb 1.0 (or compatible)
 - POSIX.1-2001 or later (getopt, nanosleep, glob)

Compilation and Installation
----------------------------

Notes on Implementation
-----------------------