https://github.com/keyboardio/Kaleidoscope

Firmware for Keyboardio keyboards and other keyboards with AVR or ARM MCUs.
https://github.com/keyboardio/Kaleidoscope

Last synced: 5 days ago
JSON representation

Firmware for Keyboardio keyboards and other keyboards with AVR or ARM MCUs.

• Host: GitHub
• URL: https://github.com/keyboardio/Kaleidoscope
• Owner: keyboardio
• License: gpl-3.0
• Created: 2013-11-02T03:59:51.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T08:57:03.000Z (4 months ago)
• Last Synced: 2024-07-03T05:23:04.111Z (4 months ago)
• Language: C++
• Homepage: http://keyboard.io
• Size: 22.4 MB
• Stars: 744
• Watchers: 38
• Forks: 258
• Open Issues: 187
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - keyboardio/Kaleidoscope - Firmware for Keyboardio keyboards and other keyboards with AVR or ARM MCUs. (others)

README

        
# Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and a number of [example firmware "Sketches"](https://github.com/keyboardio/Kaleidoscope/tree/master/examples).

# Getting Started

If you want to use Kaleidoscope to customize or compile a "sketch" to power a supported keyboard, the fastest way to get started is to use the Arduino IDE. You can find [setup instructions](https://kaleidoscope.readthedocs.io/en/latest/quick_start.html) on [kaleidoscope.readthedocs.io](https://kaleidoscope.readthedocs.io)

If you prefer to work from the command line or intend to work on Kaleidscope itself, please follow the instructions below. It's important to note that the Arduino IDE needs the source code laid out in a slightly different arrangement than you'll find in this repository. If you want to use the Arduino IDE, you should follow [these instructions](https://kaleidoscope.readthedocs.io/en/latest/quick_start.html) instead. Even if you're using the command line, you may want to refer to the docs for troubleshooting steps.

# Use git to check out a copy of Kaleidoscope

1. Open a commandline shell and navigate to where you want to check out Kaleidoscope.

For the purposes of this tutorial, we'll assume your checkout is in a directory called `Kaleidoscope` inside a directory called `git` in your home directory.

```sh

$ mkdir ${HOME}/git

$ cd ${HOME}/git

```

2. Download the latest version of Kaleidoscope

```sh

$ git clone https://github.com/keyboardio/Kaleidoscope

```

3.  Ask Kaleidoscope to install the compiler toolchain, arduino-cli and platform support

```sh

$ cd ${HOME}/git/Kaleidoscope

$ make setup

```

4.  Tell your shell where to find your Kaleidoscope installation. This example is for bash. If you're using another shell, consult the shell's documentation for instructions about how to set an environment variable

```sh

$ export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope

$ echo "export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope" >> ${HOME}/.bash_profile

```

5.  Build the Kaleidoscope Firmware for your keyboard

(This part assumes you're building firmware for the Keyboardio Atreus)

```sh

$ cd examples/Devices/Keyboardio/Atreus

$ make compile

```

5.  Install your firmware

```sh

$ make flash

```

<3 jesse