Git Product home page Git Product logo

oyviaase / kaleidoscope Goto Github PK

View Code? Open in Web Editor NEW

This project forked from keyboardio/kaleidoscope

0.0 0.0 0.0 17.66 MB

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

Home Page: http://keyboard.io

License: GNU General Public License v3.0

Shell 0.35% C++ 83.91% Python 8.38% Perl 0.51% C 5.14% Makefile 0.51% CMake 0.68% Dockerfile 0.03% Starlark 0.49%

kaleidoscope's Introduction

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and a number of example firmware "Sketches".

If you're just getting started with the Keyboardio Model 01, the introductory docs are here and the source for the basic firmware package is here: https://github.com/keyboardio/Model01-Firmware. It's probably a good idea to start there, learn how to modify your keymap and maybe turn some modules on or off, and then come back to the full repository when you have more complex changes in mind. (The firmware for all other devices is inside examples/Devices in this Kaleidoscope repo.)

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 on 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 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.

$ mkdir ${HOME}/git
$ cd ${HOME}/git
  1. Download the latest version of Kaleidoscope
$ git clone https://github.com/keyboardio/Kaleidoscope
  1. Ask Kaleidoscope to install the compiler toolchain, arduino-cli and platform support
$ cd ${HOME}/git/Kaleidoscope
$ make setup
  1. 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
$ export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope

$ echo "export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope" >> ${HOME}/.bash_profile
  1. Build the Kaleidoscope Firmware for your keyboard

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

$ cd examples/Devices/Keyboardio/Atreus

$ make compile
  1. Install your firmware
$ make flash

<3 jesse

kaleidoscope's People

Contributors

advisoray avatar algernon avatar aspiers avatar cdisselkoen avatar cscorley avatar gedankenexperimenter avatar glasser avatar hkmix avatar iliana avatar indirect avatar jamadagni avatar jamesnvc avatar jennigma avatar kingparra avatar martinakcsilla avatar mattvenn avatar maxg87 avatar ninjaaron avatar noerw avatar nospam2000 avatar numist avatar obra avatar sjb avatar technomancy avatar the-compiler avatar tiltowait avatar tlyu avatar toykeeper avatar tremby avatar wildlymanifest avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.