Skip to content

Commit

Permalink
Remove some outdated duplicative installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
obra committed Mar 15, 2022
1 parent fefb8c0 commit 9cc3867
Showing 1 changed file with 4 additions and 29 deletions.
33 changes: 4 additions & 29 deletions README.md
@@ -1,24 +1,13 @@
# Keyboardio Model 01 Firmware

_The default firmware for the Keyboardio Model 01_
This is the source code for the default firmware for the Keyboardio Model 01, as shipped from the factory.

<h3>This is a quick start guide for folks who are familiar with Arduino and prefer to use the command line. For everyone else:
If you don't intend to customize your keyboard's firmware, you may want to consider using [Chrysalis](https://github.com/keyboardio/Chrysalis), our graphical configuration tool instead.

* [Check out the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Keyboardio-Model-01-Introduction) for a more in depth introduction to how the Model 01 keyboard and the Kaleidoscope firmware work.

* If you have questions, [The community forums are happy to help!](https://community.keyboard.io/)</h3>
To use or customize this firmware, you need to have Arduino and Kaleidoscope installed on your computer.

# Download and install
If you don't yet have Kaleidoscope and Arduino installed on your computer, [set them up now](https://kaleidoscope.readthedocs.io/en/latest/setup_toolchain.html)

## Set up the Arduino IDE

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.

Out of the box, Arduino does not include support for Kaleidoscope keyboards. To be able to build and install new firmware on your keyboard, you will need to teach Arduino about Kaleidoscope.

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)

Once that's done, you're ready to download the Model 01's firmware source code.

## Download the Model 01 Firmware

Expand All @@ -30,17 +19,6 @@ git clone https://github.com/keyboardio/Model01-Firmware.git

Before you begin, make sure your Model 01 is connected to your computer.

### Option 1: From the command line

```sh
cd Model01-Firmware
make flash
```

When the builder tells you to hit Enter to continue, hold down "Prog" in the top left corner of your keyboard and hit Enter.

### Option 2: From the Arduino IDE

Open the sketch you wish to flash (for example, `Model01-Firmware.ino`).

Make sure that you've picked the Model 01 from the Boards list in the tools menu.
Expand All @@ -49,13 +27,10 @@ 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

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 also find Kaleidoscope-specific documentation [on our wiki](https://github.com/keyboardio/Kaleidoscope/wiki).

# 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.
Expand Down

0 comments on commit 9cc3867

Please sign in to comment.