Skip to content
index.rst 2.73 KiB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. include:: abbreviation.txt
.. include:: project-links.txt

.. raw:: html

    <style>
        .small-text {font-size: smaller}

	.spacer {height: 30px}

        .reduced-width {
	    max-width: 800px
        }

        .row {clear: both}

        @media only screen and (min-width: 1000px),
               only screen and (min-width: 500px) and (max-width: 768px){

            .column {
                padding-left: 5px;
                padding-right: 5px;
                float: left;
            }

            .column2  {
                width: 50%;
            }

            .column3  {
                width: 33.3%;
            }
        }
    </style>

.. raw:: html

   <div class="reduced-width">

Fabrice Salvaire's avatar
Fabrice Salvaire committed
############################
 The Pythonic Gcode Machine
############################
Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. .. image:: /_static/logo.png
..    :alt: PythonicGcodeMachine logo
..    :width: 750
Fabrice Salvaire's avatar
Fabrice Salvaire committed

********
Overview
********

Fabrice Salvaire's avatar
Fabrice Salvaire committed
PythonicGcodeMachine is a free and open source (*) Python toolkit to work with RS-274 / ISO G-Code.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. rst-class:: small-text

Fabrice Salvaire's avatar
Fabrice Salvaire committed
    (*) PythonicGcodeMachine is licensed under GPLv3 therms.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
PythonicGcodeMachine requires Python 3 and works on Linux, Windows and OS X.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
:ref:`To read more on PythonicGcodeMachine <overview-page>`
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. raw:: html

   <div class="spacer"></div>

.. rst-class:: clearfix row

.. rst-class:: column column2

:ref:`news-page`
================

What's changed in versions

.. rst-class:: column column2

:ref:`Installation-page`
========================

Fabrice Salvaire's avatar
Fabrice Salvaire committed
How to install PythonicGcodeMachine on your system
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. rst-class:: column column2

:ref:`user-faq-page`
====================

Answers to frequent questions

.. rst-class:: column column2

:ref:`examples-page`
====================

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Many examples to learn how to use PythonicGcodeMachine.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. rst-class:: column column2

:ref:`development-page`
=======================

How to contribute to the project

.. rst-class:: column column2

:ref:`reference-manual-page`
============================

Technical reference material, for classes, methods, APIs, commands.

.. rst-class:: column column2

:ref:`how-to-refer-page`
========================

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Guidelines to cite PythonicGcodeMachine
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. rst-class:: column column2

:ref:`donate-page`
==================

If you want to donate to the project or need a more professional support.

.. raw:: html

   </div>

.. why here ???

.. rst-class:: clearfix row

.. raw:: html

   <div class="spacer"></div>

*******************
 Table of Contents
*******************

.. toctree::
  :maxdepth: 3
  :numbered:

  overview.rst
  news.rst
  roadmap.rst
  installation.rst
  faq.rst
Fabrice Salvaire's avatar
Fabrice Salvaire committed
  examples/index.rst
  gcode-reference/index.rst
Fabrice Salvaire's avatar
Fabrice Salvaire committed
  design-notes.rst
  reference-manual.rst
  development.rst
  how-to-refer.rst
  donate.rst
  related-projects.rst
  bibliography.rst