Kaleidoscope/docs/index.rst

.. Kaleidoscope documentation master file, created by
   sphinx-quickstart on Fri Jan  3 13:52:38 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Kaleidoscope
============


Flexible firmware for computer keyboards.

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

If you're just getting started with the Keyboardio Model 01, the [introductory docs are here](https://github.com/keyboardio/Kaleidoscope/wiki/Keyboardio-Model-01-Introduction) 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.

Installation and setup
======================

.. toctree::
   :maxdepth: 2
  
   quick_start  


For users
=========


Supported input devices
-----------------------
.. toctree::
   :maxdepth: 2
   :glob:

   hardware-devices/*

Topic overviews
---------------
.. toctree::
   :maxdepth: 1
   :glob: 

   overviews/*

Customization reference
-----------------------
.. toctree::
   :maxdepth: 1
   :glob: 

   customization/*

Plugins 
-------
.. toctree::
   :maxdepth: 1
   :glob: 

   plugins/*


For developers
==============

Understanding the codebase
--------------------------

.. toctree::
   :maxdepth: 1
  
   codebase/design-philosophy.md
   codebase/glossary.md
   codebase/code-style.md
   codebase/release-testing.md

API Design docs
---------------

.. toctree::
   :maxdepth: 1
   :glob:

   api-reference/*


Device drivers
--------------
.. toctree::
   :maxdepth: 1
   :glob:

   drivers/**


Development tips
----------------
.. toctree::
   :maxdepth: 1
   :glob:

   development/**


What's new in v2.0
------------------
.. toctree::
   :maxdepth: 2

   NEWS.md

Upgrading from old versions
---------------------------
   
.. toctree::
   :maxdepth: 1

   UPGRADING.md


For Everybody
=============

.. toctree::
   :maxdepth: 0

   code_of_conduct.md


WIP
===


.. toctree::
   :maxdepth: 2
  
   examples
   about
   api/library_root

   :caption: Contents:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`



Links
=====

`Source code on GitHub <https://github.com/keyboardio/kaleidoscope>`_