Commit 1bb108f1 authored by Fabrice Salvaire's avatar Fabrice Salvaire

readme

parent e0ec0684
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>The Pythonic Gcode Machine</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="the-pythonic-gcode-machine">
<h1 class="title">The Pythonic Gcode Machine</h1>
<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |PythonicGcodeMachineUrl|
|PythonicGcodeMachineHomePage|_
|PythonicGcodeMachineDoc|_
|PythonicGcodeMachine@github|_
|PythonicGcodeMachine@readthedocs|_
|PythonicGcodeMachine@readthedocs-badge|
|PythonicGcodeMachine@pypi|_ -->
<!-- .. _PythonicGcodeMachine@github: https://github.com/FabriceSalvaire/PythonicGcodeMachine -->
<!-- .. _PythonicGcodeMachine@pypi: https://pypi.python.org/pypi/PythonicGcodeMachine -->
<!-- coverage test -->
<!-- https://img.shields.io/pypi/status/Django.svg -->
<!-- https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star -->
<!-- -*- Mode: rst -*- -->
<p><a class="reference external" href="https://pypi.python.org/pypi/PythonicGcodeMachine"><object data="https://img.shields.io/pypi/l/PythonicGcodeMachine.svg" type="image/svg+xml">PythonicGcodeMachine license</object></a>
<a class="reference external" href="https://pypi.python.org/pypi/PythonicGcodeMachine"><object data="https://img.shields.io/pypi/pyversions/PythonicGcodeMachine.svg" type="image/svg+xml">PythonicGcodeMachine python version</object></a></p>
<p><a class="reference external" href="https://pypi.python.org/pypi/PythonicGcodeMachine"><object data="https://img.shields.io/pypi/v/PythonicGcodeMachine.svg" type="image/svg+xml">PythonicGcodeMachine last version</object></a></p>
<ul class="simple">
<li>Quick Link to <a class="reference external" href="https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/master">Production Branch</a></li>
<li>Quick Link to <a class="reference external" href="https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/devel">Devel Branch</a></li>
</ul>
<div class="section" id="overview">
<h1>Overview</h1>
<div class="section" id="what-is-pythonicgcodemachine">
<h2>What is PythonicGcodeMachine ?</h2>
<!-- free and open source -->
<p>PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.</p>
</div>
<div class="section" id="where-is-the-documentation">
<h2>Where is the Documentation ?</h2>
<p>The documentation is available on the <a class="reference external" href="&#64;project_url&#64;">PythonicGcodeMachine Home Page</a>.</p>
</div>
<div class="section" id="what-are-the-main-features">
<h2>What are the main features ?</h2>
<ul class="simple">
<li>to be completed</li>
</ul>
</div>
<div class="section" id="how-to-install-it">
<h2>How to install it ?</h2>
<p>Look at the <a class="reference external" href="&#64;project_url&#64;/installation.html">installation</a> section in the documentation.</p>
</div>
</div>
<div class="section" id="credits">
<h1>Credits</h1>
<p>Authors: <a class="reference external" href="http://fabrice-salvaire.fr">Fabrice Salvaire</a></p>
</div>
<div class="section" id="news">
<h1>News</h1>
<!-- -*- Mode: rst -*- -->
<!-- no title here -->
<div class="section" id="v0-2018-12-22">
<h2>V0 2018-12-22</h2>
<p>Started project</p>
</div>
</div>
</div>
</body>
</html>
.. -*- Mode: rst -*-
.. -*- Mode: rst -*-
..
|PythonicGcodeMachineUrl|
|PythonicGcodeMachineHomePage|_
|PythonicGcodeMachineDoc|_
|PythonicGcodeMachine@github|_
|PythonicGcodeMachine@readthedocs|_
|PythonicGcodeMachine@readthedocs-badge|
|PythonicGcodeMachine@pypi|_
.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
:target: https://www.openhub.net/accounts/fabricesalvaire
:alt: Fabrice Salvaire's Ohloh profile
:height: 15px
:width: 80px
.. |PythonicGcodeMachineUrl| replace:: @project_url@
.. |PythonicGcodeMachineHomePage| replace:: PythonicGcodeMachine Home Page
.. _PythonicGcodeMachineHomePage: @project_url@
.. |PythonicGcodeMachine@readthedocs-badge| image:: https://readthedocs.org/projects/PythonicGcodeMachine/badge/?version=latest
:target: http://PythonicGcodeMachine.readthedocs.org/en/latest
.. |PythonicGcodeMachine@github| replace:: https://github.com/FabriceSalvaire/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@github: https://github.com/FabriceSalvaire/PythonicGcodeMachine
.. |PythonicGcodeMachine@pypi| replace:: https://pypi.python.org/pypi/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@pypi: https://pypi.python.org/pypi/PythonicGcodeMachine
.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine.svg?branch=master
:target: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine
:alt: PythonicGcodeMachine build status @travis-ci.org
.. |Pypi Version| image:: https://img.shields.io/pypi/v/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine last version
.. |Pypi License| image:: https://img.shields.io/pypi/l/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine license
.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine python version
.. coverage test
.. https://img.shields.io/pypi/status/Django.svg
.. https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star
.. -*- Mode: rst -*-
.. |Python| replace:: Python
.. _Python: http://python.org
.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi
.. |Numpy| replace:: Numpy
.. _Numpy: http://www.numpy.org
.. |IPython| replace:: IPython
.. _IPython: http://ipython.org
.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org
.. |NIST-RS-274| replace:: The NIST RS274NGC Interpreter — Version 3
.. _NIST-RS-274: https://www.nist.gov/publications/nist-rs274ngc-interpreter-version-3
.. |LinuxCNC| replace:: Linux CNC
.. _LinuxCNC: http://linuxcnc.org/docs/2.7/html/gcode/overview.html
.. |Machinekit| replace:: Machinekit
.. _Machinekit: http://www.machinekit.io
.. |YAML| replace:: YAML
.. _YAML: https://yaml.org
============================
The Pythonic Gcode Machine
============================
|Pypi License|
|Pypi Python Version|
|Pypi Version|
* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/devel>`_
Overview
========
What is PythonicGcodeMachine ?
------------------------------
.. free and open source
PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.
Where is the Documentation ?
----------------------------
The documentation is available on the |PythonicGcodeMachineHomePage|_.
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
====
.. -*- Mode: rst -*-
.. no title here
V0 2018-12-22
-------------
Started project
......@@ -3,9 +3,9 @@
.. include:: project-links.txt
.. include:: abbreviation.txt
============
PythonicGcodeMachine
============
============================
The Pythonic Gcode Machine
============================
|Pypi License|
|Pypi Python Version|
......@@ -19,9 +19,11 @@ Overview
========
What is PythonicGcodeMachine ?
---------------------
------------------------------
PythonicGcodeMachine is a Python module which implements ...
.. free and open source
PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.
Where is the Documentation ?
----------------------------
......
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