diff options
| author | Jesse Vincent <jesse@keyboard.io> | 2017-10-02 23:21:27 -0700 |
|---|---|---|
| committer | Jesse Vincent <jesse@keyboard.io> | 2017-10-02 23:21:27 -0700 |
| commit | 50abef7b54386996d2b619679c485fa9d522a735 (patch) | |
| tree | 1f9bd27eb32114aba4975e0eeb3f0da2670e64dd /README.md | |
| parent | Slightly simplify the default keymaps, removing some duplication (diff) | |
| download | keyboardio-model01-50abef7b54386996d2b619679c485fa9d522a735.tar.gz keyboardio-model01-50abef7b54386996d2b619679c485fa9d522a735.tar.bz2 keyboardio-model01-50abef7b54386996d2b619679c485fa9d522a735.zip | |
add notes about updating firmware and libraries to the README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 27 insertions, 2 deletions
@@ -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. - -# 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. + +# 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 As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource. |