Skip to content

Commit 35aa447

Browse files
committed
Finish documentation
1 parent fb11f52 commit 35aa447

File tree

5 files changed

+30
-5
lines changed

5 files changed

+30
-5
lines changed

docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@ interface to the LEDs on the MasterKeys keyboard series.
1010
:caption: Contents:
1111

1212
source/devices
13-
source/contributing
13+
source/examples/index
1414
Documentation: libmk <source/libmk/index>
1515
Documentation: masterkeys <source/masterkeys/index>
16-
source/examples/index
1716

1817
.. |Travis| image:: https://api.travis-ci.com/RedFantom/masterkeys-linux.svg
1918
:alt: Travis-CI Build Status

docs/source/contributing.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/source/examples/ambilight.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
AmbiLight
2+
=========
3+
4+
Fast screenshot capture program that calculates the dominant color
5+
(average of colors with high hue) visible on the screen and sets it as
6+
the only color of the keyboard. Is capable of reaching somewhere between
7+
20 and 30 FPS on most machines.
8+
9+
.. literalinclude:: ../../../examples/ambilight/ambilight.c
10+
:language: c
11+
:linenos:

docs/source/examples/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
Examples
22
========
33

4+
In this section, a set of examples is provided as a simple reference on
5+
how the libraries may be used in a practical manner. The examples are
6+
extensively tested and a good way to determine whether building and
7+
installing the libraries was successful and the library is capable of
8+
controlling your device.
49

10+
.. toctree::
11+
Photo Viewer: Python <photo>
12+
AmbiLight: C <ambilight>

docs/source/examples/photo.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Photo Viewer
2+
============
3+
4+
Simple Python program that reads a specified image file and calculates
5+
a color matrix based on this image by averaging the pixels. The image is
6+
then set on the keyboard.
7+
8+
.. literalinclude:: ../../../examples/photoviewer/viewer.py
9+
:language: python
10+
:linenos:

0 commit comments

Comments
 (0)