kreyren/OSHW-DEIMOS
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Add links; formatting; moving license to own file

Browse Source
This commit is contained in:
JC Staudt 2018-06-23 17:19:41 -07:00 committed by GitHub
parent a5587dfa07
commit f4aaeb9996
Signed by: GitHub
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
SOFTWARE/A64-TERES/TERES-KBD-RELEASE/README.md
View File

@ -4,30 +4,31 @@ How to compile the keyboard and touchpad firmware for TERES-I:
1. Make sure that you are performing these steps on the TERES-I itself.
2. Go to the directory
2. 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/
Extract the archive inside "TERES-KBD-RELEASE/" to directory lufa-LUFA-170418
3. Download Dean Camera's LUFA USB stack from http://www.fourwalledcubicle.com/.
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/", navigate there to edit the build depndencies:
4. 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/
5. Edit the makefile inside [TERES-KBD-RELEASE/TERES-HID/](TERES-HID):
```bash
nano makefile
```
search for LUFA_PATH and make sure it point to LUFA library:
search for `LUFA_PATH` and make sure it point to the LUFA library:
```bash
LUFA_PATH = ../lufa-LUFA-170418/LUFA
```
save file and exit nano
Save the file and exit the text editor.
6. Compile
6. Compile:
```bash
make
```
@ -35,26 +36,12 @@ make
```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!
You will be prompted to press "fn+Tux+ESC" (function + penguin + escape) keys simultanously at some point.
Make sure to do so!
8. Voila! Updade successful.
8. Voila!
Update successful!
Note 1: If you wish to play with the behavior yourself edit the sources in TERES-KBD-RELEASE/TERES-HID/
Note 2: If you have problems with the touchpad and it seems dead, make sure that you haven't disabled it with fn+F3
**Note 1**: If you wish to play with the behavior yourself edit the sources in [TERES-KBD-RELEASE/TERES-HID/](TERES-HID).
The code is based on Dean Camera's LUFA USB stack. More info at:
http://www.fourwalledcubicle.com/
The LUFA library is currently released under the MIT license, included below.
Copyright (C) Dean Camera, 2016 dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
Permission to use, copy, modify, and distribute this software and its documentation for any purpose
is hereby granted without fee, provided that the above copyright notice appear in all copies and that
both that the copyright notice and this permission notice and warranty disclaimer appear in
supporting documentation, and that the name of the author not be used in advertising or publicity
pertaining to distribution of the software without specific, written prior permission.
The author disclaims all warranties with regard to this software, including all implied warranties of
merchantability and fitness. In no event shall the author be liable for any special, indirect or
consequential damages or any damages whatsoever resulting from loss of use, data or profits,
whether in an action of contract, negligence or other tortuous action, arising out of or in connection
with the use or performance of this software.
# TERES-KBD-RELEASE
**Note 2**: If you have problems with the touchpad and it seems dead, make sure that you haven't disabled it with fn+F3.