Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.94 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.94 KB

Kaleidoscope-Timekeeper

Type current date.

status

Installation

Install this plugin as you would any other 3rd-party plugin. Specifically:

  1. Find your plugin directory. This is wherever you normally put plugins; it should be $SKETCHBOOK_DIR/hardware/keyboardio/avr/libraries, or at least accessible from there via symlink. $SKETCHBOOK_DIR is your Arduino sketchbook directory, perhaps $HOME/Arduino or $HOME/Documents/Arduino.
  2. Install this plugin into your plugin directory using one of the below options.
  • (Option 1 - using Git) Clone this Git repo into your plugin directory. This can be done from the command line - just navigate to your plugin directory and type git clone https://github.com/jjochen/Kaleidoscope-Timekeeper.
  • (Option 2 - no Git or command-line required) Click the green "Clone or download" button at the top right of this page, and select "Download ZIP". Then, unzip the folder in your plugin directory.

You're done!

Adding the plugin to your sketch

To activate the plugin, you need to include the header, tell Kaleidoscope to use the plugin, and place the Key_Timekeeper key on your key map.

Setup operations in the firmware sketch (example):

#include <Kaleidoscope.h>
#include <Kaleidoscope-Timekeeper.h>


KALEIDOSCOPE_INIT_PLUGINS(Timekeeper);

Keys

...

Dependencies

Further reading

The example is a working sketch using Kaleidoscope-Timekeeper.