README.txt 1.07 KB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
1 2 3 4 5
.. -*- Mode: rst -*-

.. include:: project-links.txt
.. include:: abbreviation.txt

Fabrice Salvaire's avatar
Fabrice Salvaire committed
6 7 8
=============================
 The Pythonic G-code Machine
=============================
Fabrice Salvaire's avatar
Fabrice Salvaire committed
9 10 11 12 13 14

|Pypi License|
|Pypi Python Version|

|Pypi Version|

Fabrice Salvaire's avatar
Fabrice Salvaire committed
15 16
* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/devel>`_
Fabrice Salvaire's avatar
Fabrice Salvaire committed
17 18 19 20

Overview
========

Fabrice Salvaire's avatar
Fabrice Salvaire committed
21
What is PythonicGcodeMachine ?
Fabrice Salvaire's avatar
Fabrice Salvaire committed
22
------------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed
23

Fabrice Salvaire's avatar
Fabrice Salvaire committed
24 25 26
.. free and open source

PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
27

Fabrice Salvaire's avatar
Fabrice Salvaire committed
28
.. include:: features.txt
Fabrice Salvaire's avatar
Fabrice Salvaire committed
29

Fabrice Salvaire's avatar
Fabrice Salvaire committed
30 31 32
Where is the Documentation ?
----------------------------

Fabrice Salvaire's avatar
Fabrice Salvaire committed
33
The documentation is available on the |PythonicGcodeMachineHomePage|_.
Fabrice Salvaire's avatar
Fabrice Salvaire committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

What are the main features ?
----------------------------

* to be completed

How to install it ?
-------------------

Look at the `installation <@project_url@/installation.html>`_ section in the documentation.

Credits
=======

Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_

News
====

.. include:: news.txt