From a526069c7a4026485e3eb57ce88f1224300cce05 Mon Sep 17 00:00:00 2001 From: JC Staudt Date: Fri, 28 Dec 2018 08:22:26 -0800 Subject: [PATCH] Minor formatting --- .../A64-TERES/TERES-KBD-RELEASE/README.md | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/SOFTWARE/A64-TERES/TERES-KBD-RELEASE/README.md b/SOFTWARE/A64-TERES/TERES-KBD-RELEASE/README.md index 79e8ab6f..3669c8b5 100644 --- a/SOFTWARE/A64-TERES/TERES-KBD-RELEASE/README.md +++ b/SOFTWARE/A64-TERES/TERES-KBD-RELEASE/README.md @@ -1,24 +1,23 @@ # TERES-KBD-RELEASE -How to compile the keyboard and touchpad firmware for TERES-I: +The purpose of this document is to describe how to compile the keyboard and touchpad firmware for the TERES-I. +Make sure that you are performing these steps on the TERES-I itself. -1. Make sure that you are performing these steps on the TERES-I itself. - -2. Go to this directory +1. Go to this directory ```bash cd SOFTWARE/A64-TERES/TERES-KBD-RELEASE/ ``` -3. Download Dean Camera's LUFA USB stack from http://www.fourwalledcubicle.com/. +2. Download Dean Camera's LUFA USB stack [here](http://www.fourwalledcubicle.com/LUFA.php). Extract the archive inside [TERES-KBD-RELEASE/](.) to directory lufa-LUFA-170418 ```bash unzip lufa-LUFA-170418.zip ``` -4. The Olimex keyboard + touchpad code is located in [TERES-KBD-RELEASE/TERES-HID/](TERES-HID). +3. The Olimex keyboard + touchpad code is located in [TERES-KBD-RELEASE/TERES-HID/](TERES-HID). Navigate there to edit the build dependencies: ```bash cd TERES-HID/ ``` -5. Edit the makefile inside [TERES-KBD-RELEASE/TERES-HID/](TERES-HID): +4. Edit the makefile inside [TERES-KBD-RELEASE/TERES-HID/](TERES-HID): ```bash nano makefile ``` @@ -28,19 +27,18 @@ LUFA_PATH = ../lufa-LUFA-170418/LUFA ``` Save the file and exit the text editor. -6. Compile: +5. Compile: ```bash make ``` -7. Update the firmware of the TERES-I's keyboard and touchpad firmware: +6. Update the firmware of the TERES-I's keyboard and touchpad firmware: ```bash sudo ./update ``` You will be prompted to press "fn+Tux+ESC" (function + penguin + escape) keys simultanously at some point. Make sure to do so! -8. Voila! -Update successful! +7. Finished! **Note 1**: If you wish to play with the behavior yourself edit the sources in [TERES-KBD-RELEASE/TERES-HID/](TERES-HID).