forked from keyboardio/Kaleidoscope
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add custom layouts for Model01 and Model100
- Loading branch information
Showing
12 changed files
with
874 additions
and
1,240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ | |
/results/ | ||
generated-testcase.cpp | ||
bin/arduino-cli | ||
.ccls* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,65 +1,36 @@ | ||
# Kaleidoscope | ||
|
||
My custom layouts for Keyboardio Model 01 and Model 100. | ||
|
||
Flexible firmware for Arduino-powered keyboards. | ||
[![layout](keyboardio-model-100.png)](http://www.keyboard-layout-editor.com/#/gists/89e0b9ceb38f90dcd676edbe32bd696f) | ||
|
||
This package contains the "core" of Kaleidoscope and a number of [example firmware "Sketches"](https://github.com/keyboardio/Kaleidoscope/tree/master/examples). | ||
## Usage | ||
|
||
# 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. | ||
Clone this repo to `$HOME`. | ||
|
||
```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 | ||
``` | ||
# BASH | ||
$ echo "export KALEIDOSCOPE_DIR=${HOME}/Kaleidoscope" >> ${HOME}/.bash_profile | ||
|
||
5. Build the Kaleidoscope Firmware for your keyboard | ||
# ZSH | ||
$ echo "export KALEIDOSCOPE_DIR=${HOME}/Kaleidoscope" >> ${HOME}/.zshrc | ||
``` | ||
|
||
(This part assumes you're building firmware for the Keyboardio Atreus) | ||
### Keyboardio Model 01 | ||
|
||
```sh | ||
$ cd examples/Devices/Keyboardio/Atreus | ||
|
||
$ cd examples/Devices/Keyboardio/Model01/ | ||
$ make compile | ||
$ make flash | ||
``` | ||
|
||
5. Install your firmware | ||
### Keyboardio Model 100 | ||
|
||
```sh | ||
$ make flash | ||
|
||
$ cd examples/Devices/Keyboardio/Model100/ | ||
``` | ||
|
||
<3 jesse | ||
|
||
Follow the `README.md` there. |
Oops, something went wrong.