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

.. _overview-page:

==========
 Overview
==========

Fabrice Salvaire's avatar
Fabrice Salvaire committed
What is PythonicGcodeMachine ?
Fabrice Salvaire's avatar
Fabrice Salvaire committed
------------------------------
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
.. include:: features.txt
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
How is PythonicGcodeMachine licensed ?
Fabrice Salvaire's avatar
Fabrice Salvaire committed
--------------------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed
PythonicGcodeMachine is licensed under the `GPLv3 <https://www.gnu.org/licenses/quick-guide-gplv3.en.html>`_.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
Going further with PythonicGcodeMachine
Fabrice Salvaire's avatar
Fabrice Salvaire committed
---------------------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed
The best way to know what you can do with PythonicGcodeMachine, and to learn it, is to look at the examples:
Fabrice Salvaire's avatar
Fabrice Salvaire committed
 * :ref:`PythonicGcodeMachine Reference Manual <reference-manual-page>`
Fabrice Salvaire's avatar
Fabrice Salvaire committed
 * :ref:`Bibliography <bibliography-page>`

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Which platforms are supported by PythonicGcodeMachine ?
Fabrice Salvaire's avatar
Fabrice Salvaire committed
-------------------------------------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed
PythonicGcodeMachine runs on Linux, Windows 64-bit and Mac OS X.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
How to install PythonicGcodeMachine ?
Fabrice Salvaire's avatar
Fabrice Salvaire committed
-------------------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed
The procedure to install PythonicGcodeMachine is described in the :ref:`Installation Manual <installation-page>`.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Which version of Python is required ?
-------------------------------------

Fabrice Salvaire's avatar
Fabrice Salvaire committed
PythonicGcodeMachine requires at least Python 3.5.