Commit fbbf5990 authored by Nathan/Eilisha Shiraini's avatar Nathan/Eilisha Shiraini
Browse files

Added the doc index file

parent 01375eca
.. ColorCode documentation master file, created by
sphinx-quickstart on Mon Sep 20 10:39 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ColorCode's documentation!
=====================================
ColorCode is a Python program and libraries to create 1D and 2D codes.
The specificities of ColorCode is that the ultimate goal
is to combine 3 of these codes into a single image!
For that reason, the submodules for code creation
accept a forced size for the code, in order to generate
3 codes of the same final size.
These codes are then combined into a single image, one as the red canal,
one as the green and one as the blue. Other interpolations are possible,
but the may not be correctly picked up by sensors like phone cameras.
This program has been greatly inspired by the ZXing library,
a Java library to encode and decode 2D codes.
.. toctree::
:maxdepth: 2
:caption: Contents:
_doc/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment