Updated Manual

This commit is contained in:
jpcaram
2015-01-06 17:10:20 -05:00
parent ddd90f9f33
commit 26d9e6c837
15 changed files with 313 additions and 51 deletions

View File

@@ -60,6 +60,21 @@ Generates a CNC Job from a Geometry Object.
outname: Name of the output object
cutout
~~~~~~
Creates cutout board.
> cutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (4|tb|lr)>]
name: Name of the object
dia: Tool diameter
margin: # margin over bounds
gapsize: size of gap
gaps: type of gaps
delete
~~~~~~
Deletes the give object.
@@ -67,6 +82,23 @@ Deletes the give object.
> delete <name>
name: Name of the object to delete.
drillcncjob
~~~~~~~~~~~
Drill CNC job.
> drillcncjob <name> -tools <str> -drillz <float> -travelz <float> -feedrate <float> -outname <str>
name: Name of the object
tools: Comma separated indexes of tools (example: 1,3 or 2)
drillz: Drill depth into material (example: -2.0)
travelz: Travel distance above material (example: 2.0)
feedrate: Drilling feed rate
outname: Name of object to create
follow
~~~~~~
Creates a geometry object following gerber paths.
@@ -114,6 +146,17 @@ make_docs
~~~~~~~~~
Prints command rererence in reStructuredText format.
mirror
~~~~~~
Mirror board.
> mirror <nameMirroredObject> -box <nameOfBox> [-axis <X|Y>]
name: Name of the object (Gerber or Excellon) to mirror
box: Name of object which acts as box (cutout for example)
axis: Axis mirror over X or Y
new
~~~
Starts a new project. Clears objects from memory.