summaryrefslogtreecommitdiff
path: root/Compile.html
diff options
context:
space:
mode:
authorPetr Mrázek2010-08-10 01:21:47 +0200
committerPetr Mrázek2010-08-10 01:21:47 +0200
commitdac7e45a4474e7f32872e73c3ab0c5db4f071076 (patch)
tree47530a351e624c20e60b864dd12af0dffa5dc8e1 /Compile.html
parent7aeafa01c9c1b16b96742826f7dbad5b6211e8a8 (diff)
downloaddfhack-dac7e45a4474e7f32872e73c3ab0c5db4f071076.tar.gz
dfhack-dac7e45a4474e7f32872e73c3ab0c5db4f071076.tar.bz2
dfhack-dac7e45a4474e7f32872e73c3ab0c5db4f071076.tar.xz
Fix Readme and Compile documents.
Diffstat (limited to 'Compile.html')
-rw-r--r--Compile.html26
1 files changed, 21 insertions, 5 deletions
diff --git a/Compile.html b/Compile.html
index 1e418054..06ab65b9 100644
--- a/Compile.html
+++ b/Compile.html
@@ -425,11 +425,27 @@ compiler.</p>
<div class="section" id="build-targets">
<h1><a class="toc-backref" href="#id8">Build targets</a></h1>
<p>dfhack has a few build targets:</p>
-<ul class="simple">
-<li>If you're only after the library run <tt class="docutils literal">make dfhack</tt>.</li>
-<li><tt class="docutils literal">make</tt> will build everything.</li>
-<li><tt class="docutils literal">make expbench</tt> will build the expbench testing program and the
-library.</li>
+<ul>
+<li><p class="first">If you're only after the library run <tt class="docutils literal">make dfhack</tt>.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">make</tt> will build everything.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">make expbench</tt> will build the expbench testing program and the
+library.</p>
+</li>
+<li><p class="first">Some of the utilities and the doxygen documentation won't be
+normally built. You can enable them by specifying some extra
+CMake variables:</p>
+<pre class="literal-block">
+BUILD_DFHACK_DOCUMENTATION - generate the documentation (really bad)
+BUILD_DFHACK_EXAMPLES - build tools from tools/examples
+BUILD_DFHACK_PLAYGROUND - build tools from tools/playground
+</pre>
+<p>Example:</p>
+<pre class="literal-block">
+cmake .. -DBUILD_DFHACK_EXAMPLES=ON
+</pre>
+</li>
</ul>
</div>
<div class="section" id="build-types">