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

Point users at the Arduino and Kaleidoscope documentation on the wiki instead of reproducing an incomplete, obsolete version here.

Browse Source
This commit is contained in:
Jesse Vincent 2020-06-08 20:41:52 -07:00
parent 03bee4b874
commit 8228f7a4ec
No known key found for this signature in database
GPG Key ID: CC228463465E40BC
1 changed files with 3 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -12,43 +12,9 @@ _The default firmware for the Keyboardio Model 01_
## Set up the Arduino IDE
Setup the Arduino IDE on your system. Make sure you install at least version 1.6.10, since older version may not support all required features.
### macOS
On macOS, install the Arduino IDE using [homebrew](http://brew.sh/) [cask](https://caskroom.github.io/) with `brew cask install arduino` or download the application from [the official website](https://www.arduino.cc/en/Main/Software) and move it to your `/Applications` folder.
### Linux
On Linux, your distribution's package manager probably includes the Arduino IDE, but it may be an out of date version. If your distribution installs a version of Arduino before 1.6.10, you'll need to install the Arduino IDE following the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Install-Arduino-support-on-Linux).
If you install Arduino into some place that's /not/ `/usr/local/arduino`, you'll need to set the `$ARDUINO_PATH` environment variable to the directory containing the `arduino` and `arduino-builder` binaries.
## Create and navigate to the Arduino Sketchbook directory
### MacOS
```sh
mkdir -p $HOME/Documents/Arduino
cd $HOME/Documents/Arduino
```
### Linux
```sh
mkdir -p $HOME/Arduino
cd $HOME/Arduino
```
## Download hardware platform, including library source code
```sh
mkdir -p hardware
## then clone the hardware definitions to make them available to the arduino environment
git clone --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git hardware/keyboardio
````
Setup the Arduino IDE on your system. Make sure you install at least version 1.8.11, since older version may not support all required features.
You can find Instructions for setting up the Arduino IDE and adding support for Kaleidoscope [on the Kaleidoscope wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Install-Arduino)
## Download the Model 01 Firmware
@ -71,7 +37,6 @@ When the builder tells you to hit Enter to continue, hold down "Prog" in the top
### Option 2: From the Arduino IDE
Open the sketch you wish to flash (for example, `Model01-Firmware.ino`).
Click the Upload button or press `Ctrl-U`.
@ -83,31 +48,7 @@ Hold down the "Prog" key in the top left corner of your keyboard, until the comp
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
make update-submodules
```
### Linux
```sh
cd $HOME/Arduino/hardware/keyboardio
make update-submodules
```
You can also find Kaleidoscope-specific documentation [on our wiki](https://github.com/keyboardio/Kaleidoscope/wiki).
# Getting help