Purox
/
Hackpad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Spelling, some words an qmk

main
Stephan Messlinger 2023-04-26 20:57:54 +02:00
parent 3a5c73a8ca
commit 14f0ca9d73
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
readme.md
View File

@ -10,7 +10,10 @@ We support two kinds of firmware: low level [Arduino firmware](firmware_arduino)
### Arduino Firmware
This firmware is mostly for educational purposes.
Its low level code shows how keyboard firmware works on the electronical/physical level. There is a very [basic version](firmware_arduino/hackpad_simple/hackpad_simple.ino) that only includes the bare minimum to understand the keyboard matrix. The more [advanced version](firmware_arduino/hackpad/hackpad.ino) also includes functionality like debouncing.
### QMK Firmware
[QMK](https://qmk.fm) ([TLA](https://en.wikipedia.org/wiki/Three-letter_acronym) for Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. It provides a very comprehensive firmware library, which can be customized to different keyboard hardware and layouts without the need to write own code.
#### Installing and locating QMK on your Computer
With QMK it is simple to define custom layouts and up to 32 layers.
Follow the instructions to [install](https://docs.qmk.fm/#/newbs_getting_started) QMK on your computer.
@ -21,7 +24,7 @@ Under Linux, the path is `~/qmk_firmware`, while under Windows should be `C:\\us
The QMK version from the official website, does not yet include the software definitions for the `hackpad`-keyboard, so we need to add it manually.
For this you need to copy the directory `hackpad` found at [firmware_qmk/hackpad](firmware_qmk) into the `keyboards` directory in the `qmk_firmware` you have downloaded earlier.
You can get a copy of the `hackpad` directory by downloading this repository and extracting it.
Keep in mind that there are multiple directorys called `hackpad` in this repository, i.e. the repository itself, one in the subdirectory `firmware_arduino` and one in the subdirectory `firmware_qmk`.
Keep in mind that there are multiple directories called `hackpad` in this repository, i.e. the repository itself, one in the subdirectory `firmware_arduino` and one in the subdirectory `firmware_qmk`.
You need to copy the `hackpad` directory of the subdirectory `firmware_qmk` into the `keyboards` directory of your `qmk_firmware` directory, to enable support for the hackpad keyboard in QMK.
Notice the difference between the directories `qmk_firmware` and `firmware_qmk`.
@ -30,7 +33,7 @@ Once you have completed the previous steps, you should be able to compile your f
You can find instructions on how to change you keymap in the [QMK documentation](https://docs.qmk.fm/#/newbs_building_firmware).
You can find an exhaustive list of keycodes in the [Keycodes overview of QMK](https://docs.qmk.fm/#/keycodes).
#### Flashing the firmware
After you have made your changes to the keymap you need to upload the firmware othe keyboard.
After you have made your changes to the keymap you need to upload the firmware to the keyboard.
This is done by running `qmk flash -kb hackpad -km "your keymap name"`, where `"your keymap name"` is the name of the subdirectory in the `keymaps` directory which you want to upload to the keyboard.
# Support