GitHub-Proxy/pygcode
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/petaflot/pygcode synced 2025-09-16 02:53:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

converted readme to rst

Browse Source
This commit is contained in:
Peter Boin 2017-07-18 18:28:19 +10:00
parent 512a5ac311
commit 63744fee40
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md → README.rst
View File

@ -1,19 +1,27 @@
# pygcode pygcode
=======
GCODE Parser for Python GCODE Parser for Python
Currently in development, this is planned to be a pythonic interpreter and encoder for g-code. Currently in development, this is planned to be a pythonic interpreter
I'll be learning along the way, but the plan is to follow the lead of [GRBL](https://github.com/gnea/grbl). and encoder for g-code. I'll be learning along the way, but the plan is
to follow the lead of `GRBL <https://github.com/gnea/grbl>`__.
## Installation Installation
------------
`pip install pygcode` ``pip install pygcode``
FIXME: well, that's the plan... give me some time to get it going though. FIXME: well, that's the plan... give me some time to get it going
though.
## Usage Usage
-----
Just brainstorming here... Just brainstorming here...
::
import pygcode import pygcode
import math import math
import euclid import euclid
@ -64,10 +72,15 @@ Just brainstorming here...
gfile_in.close() gfile_in.close()
gfile_out.close() gfile_out.close()
Supported G-Codes
-----------------
## Supported G-Codes GCode support is planned to follow that of
GCode support is planned to follow that of [GRBL](https://github.com/gnea/grbl) which follows [LinuxCNC](http://linuxcnc.org) (list of gcodes documented [here](http://linuxcnc.org/docs/html/gcode.html)). `GRBL <https://github.com/gnea/grbl>`__ which follows
`LinuxCNC <http://linuxcnc.org>`__ (list of gcodes documented
`here <http://linuxcnc.org/docs/html/gcode.html>`__).
But anything pre v1.0 will be a sub-set, focusing on the issues I'm having... I'm selfish that way. But anything pre v1.0 will be a sub-set, focusing on the issues I'm
having... I'm selfish that way.
TBD: list of gcodes (also as a TODO list) TBD: list of gcodes (also as a TODO list)