wxcafe/Model01-Firmware
1
0
Fork 0
Code Releases Activity

add notes about updating firmware and libraries to the README

Browse Source
This commit is contained in:
Jesse Vincent 2017-10-02 23:21:27 -07:00
parent 028b9c6dda
commit 50abef7b54
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -74,11 +74,36 @@ Click the Upload button or press `Ctrl-U`.
Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins. Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins.
# Start to customize the firmware
# Start to customize the firmware.
You can customize your keyboard's key layout and LED effects by modifying the `Model01-Firmware.ino` file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc. You can customize your keyboard's key layout and LED effects by modifying the `Model01-Firmware.ino` file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc.
# Updating the firmware and libraries
From time to time, you may want to pull the latest version of this firmware from GitHub. To do that, navigate to the Model01-Firmware directory in your shell and pull the latest code.
```sh
cd Model01-Firmware
git pull
```
After that, you'll want to update the Kaleidoscope libraries.
### MacOS
```sh
cd $HOME/Documents/Arduino/hardware/keyboardio/avr
make update-submodules
```
### Linux
```sh
cd $HOME/Arduino/hardware/keyboardio/avr
make update-submodules
```
# Getting help # Getting help
As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource. As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.