diff --git a/features/backend/index.rst b/features/backend/index.rst new file mode 100644 index 000000000..7dc56b143 --- /dev/null +++ b/features/backend/index.rst @@ -0,0 +1,52 @@ +.. _root: + +============================ +Documentation for picroscopy +============================ + +Picroscopy is a small Python web-application which is intended for usage with a +`Raspberry Pi`_ as a microscopy solution. With the `Raspberry Pi Camera`_ +mounted on a microscope, the Raspberry Pi provides a live video feed to its +monitor via HDMI, while another machine can be used to control the setup via a +web-based interface. + +The project is written in `Python`_ 3 and is open-sourced under the `GPL +license`_. Packages can be downloaded from the project `homepage`_. The `source +code`_ can be obtained from GitHub. The `documentation`_ can be read on +ReadTheDocs. + + +Table of Contents +================= + +.. toctree:: + :maxdepth: 1 + :numbered: + + install + quickstart + usage + admin + commandline + configuration + faq + license + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + + +.. _Raspberry Pi: http://www.raspberrypi.org/ +.. _Raspberry Pi Camera: http://www.raspberrypi.org/camera +.. _homepage: https://www.waveform.org.uk/picroscopy/ +.. _documentation: http://picroscopy.readthedocs.org/ +.. _source code: https://github.com/waveform80/picroscopy.git +.. _Python: http://python.org/ +.. _GPL license: http://www.gnu.org/licenses/gpl-3.0.html