add compiling hints
Stefan Schuermans commited on 2013-05-20 18:27:02
Showing 1 changed files, with 54 additions and 3 deletions.
- doc/dxfngc.xml 8a63bb3..b2ef948
| ... | ... |
@@ -181,9 +181,9 @@ write_ngc logo.ngc]]></programlisting> |
| 181 | 181 |
|
| 182 | 182 |
Once drawing and script are ready, the script can be run using the |
| 183 | 183 |
<code>dxfngc</code> tool. (It is assumed here it has already been |
| 184 |
- compiled. See !!!TODO!!! for instruction for compiling.) As the script |
|
| 185 |
- contains the filenames of input and output files, it is sufficient to |
|
| 186 |
- provide the filename of the script file to dxfngc: |
|
| 184 |
+ compiled. See <xref linkend="compiling"/> for compiling instructions.) |
|
| 185 |
+ As the script contains the filenames of input and output files, it is |
|
| 186 |
+ sufficient to provide the filename of the script file to dxfngc: |
|
| 187 | 187 |
|
| 188 | 188 |
</para> |
| 189 | 189 |
|
| ... | ... |
@@ -218,6 +218,13 @@ write_ngc logo.ngc]]></programlisting> |
| 218 | 218 |
|
| 219 | 219 |
<title>Commands</title> |
| 220 | 220 |
|
| 221 |
+ <para> |
|
| 222 |
+ |
|
| 223 |
+ This section lists all commands available for use in the dxfngc scripts. |
|
| 224 |
+ For each command, it is described what it does and how it can be used. |
|
| 225 |
+ |
|
| 226 |
+ </para> |
|
| 227 |
+ |
|
| 221 | 228 |
<sect2> |
| 222 | 229 |
|
| 223 | 230 |
<title>cmd</title> |
| ... | ... |
@@ -579,5 +586,49 @@ write_ngc logo.ngc]]></programlisting> |
| 579 | 586 |
|
| 580 | 587 |
</sect1> |
| 581 | 588 |
|
| 589 |
+ <sect1 xml:id="compiling"> |
|
| 590 |
+ |
|
| 591 |
+ <title>Compiling</title> |
|
| 592 |
+ |
|
| 593 |
+ <para> |
|
| 594 |
+ |
|
| 595 |
+ To compile dxfngc, a C++ compiler and the following libraries have to be |
|
| 596 |
+ installed, including their development files: |
|
| 597 |
+ |
|
| 598 |
+ </para> |
|
| 599 |
+ |
|
| 600 |
+ <programlisting><![CDATA[libCGAL_Core (>= 3.6) |
|
| 601 |
+libCGAL (>= 3.6) |
|
| 602 |
+libdime (>= 2003-09-21)]]></programlisting> |
|
| 603 |
+ |
|
| 604 |
+ <para> |
|
| 605 |
+ |
|
| 606 |
+ To compile dxfngc, simply call <code>make</code> from the top-level |
|
| 607 |
+ directory. |
|
| 608 |
+ |
|
| 609 |
+ </para> |
|
| 610 |
+ |
|
| 611 |
+ <sect2> |
|
| 612 |
+ |
|
| 613 |
+ <title>Compiling Documentation</title> |
|
| 614 |
+ |
|
| 615 |
+ <para> |
|
| 616 |
+ |
|
| 617 |
+ To compile the dxfngc documentation, <code>docbook (>= 5.0)</code> |
|
| 618 |
+ must be installed. |
|
| 619 |
+ |
|
| 620 |
+ </para> |
|
| 621 |
+ |
|
| 622 |
+ <para> |
|
| 623 |
+ |
|
| 624 |
+ To compile the documentation, simply call <code>make</code> from the |
|
| 625 |
+ <code>doc</code> directory. |
|
| 626 |
+ |
|
| 627 |
+ </para> |
|
| 628 |
+ |
|
| 629 |
+ </sect2> |
|
| 630 |
+ |
|
| 631 |
+ </sect1> |
|
| 632 |
+ |
|
| 582 | 633 |
</article> |
| 583 | 634 |
|
| 584 | 635 |