dxfngc

first few lines of documentation
Parent 3f2ac59
Stefan Schuermans

Stefan Schuermans commited on 2013-04-23 20:57:15
Showing 3 changed files, with 72 additions and 0 deletions.

doc/.gitignore
View file @ c4b65b5
... ... 
@@ -0,0 +1 @@
1 
+dxfngc.pdf
doc/Makefile
View file @ c4b65b5
... ... 
@@ -0,0 +1,14 @@
1 
+NAME = dxfngc
2 
+
3 
+.PHONY: all clean
4 
+.SUFFIXES:
5 
+.SECONDARY:
6 
+
7 
+all: $(NAME).pdf
8 
+
9 
+%.pdf: %.xml
10 
+	db2pdf $<
11 
+
12 
+clean:
13 
+	rm -f $(NAME).pdf
14 
+
doc/dxfngc.xml
View file @ c4b65b5
... ... 
@@ -0,0 +1,57 @@
1 
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
2 
+
3 
+<article>
4 
+
5 
+  <title>DXF to NGC Converter: dxfncg</title>
6 
+
7 
+
8 
+  <sect1 id="introduction">
9 
+
10 
+    <title>Introduction</title>
11 
+
12 
+    <para>
13 
+
14 
+      The DXF to NGC converter dxfngc provide a means to convert 2D technical
15 
+      drawings in DXF file format to G-code in NGC format used by CNC mills
16 
+      or routers (e.g. LinuxCNC).
17 
+
18 
+    </para>
19 
+
20 
+    <para>
21 
+
22 
+      Usually, the 2D drawings in DXF format do not contain enough information
23 
+      for G-code creation, e.g. about which lines describe the border of a part
24 
+      and which lines describe holes.  The diameter of the cutting tool and
25 
+      the depth of the cut are other examples.  Therefore, dxfngc relies on
26 
+      a script file to control the G-code generation.  This script is the input
27 
+      to the tool.  It sets all the parameters and controls reading the drawing
28 
+      and generation of the G-code.
29 
+
30 
+    </para>
31 
+
32 
+  </sect1>
33 
+
34 
+  <sect1 id="first-example">
35 
+
36 
+    <title>A first example</title>
37 
+
38 
+    <para>
39 
+
40 
+      To illustrate usage of dxfgnc, suppose a stencil for a logo shall be cut
41 
+      with a CNC mill.  (TODO: image)  The basic shape of the stencil is a
42 
+      circle.  The logo is formed by two holes with a specific shape.
43 
+
44 
+    </para>
45 
+
46 
+    <para>
47 
+
48 
+      First, the 2D drawing is created.  The circular border is drawn on
49 
+      layer <parameter>border</parameter> and the two holes are drawn on layer
50 
+      <parameter>holes</parameter>.
51 
+
52 
+    </para>
53 
+
54 
+  </sect1>
55 
+
56 
+</article>
57 
+
0 58