Skip to content

D
dlib
Commit ace034cc authored by Davis King's avatar Davis King
Browse files
Options

Updated compile instructions and added notes about building the python API.

parent 9988deac
Show whitespace changes
Inline Side-by-side
Showing with 22 additions and 8 deletions
docs/docs/compile.xml
View file @ ace034cc
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
<body> <body>
<h2>Compiling on Any Operating System Using CMake</h2> <h2>Compiling C++ Example Programs on Any Operating System Using CMake</h2>
The best way to compile a program that uses dlib is to use <a href="http://www.cmake.org">CMake</a>. For The best way to compile a program that uses dlib is to use <a href="http://www.cmake.org">CMake</a>. For
example, the following commands will compile the example programs on any operating example, the following commands will compile the example programs on any operating
system: system:
...@@ -44,11 +44,23 @@ tell CMake which one you want it to use via the -G option. ...@@ -44,11 +44,23 @@ tell CMake which one you want it to use via the -G option.
<br/> <br/>
<br/> <h2>Compiling Dlib's Python Interface</h2>
<p>
Go to the base folder of the dlib repository and run <tt>python setup.py install</tt>. That
should compile and install the dlib python API on your system.
</p>
<p>
Alternatively, if you want to add more python bindings to dlib's
python interface then you probably want to avoid the setup.py file
and work directly using CMake. In particular, dlib's python API is
built by the CMake project in the tools/python folder. You build
this project using the usual CMake commands and when compiled it
outputs the dlib shared library that defines the python API for dlib.
</p>
<br/> <br/>
<h2>Compiling Without CMake</h2> <h2>Compiling C++ Examples Without CMake</h2>
<p> <p>
In most cases, to use this library all you have to do is extract it somewhere, make In most cases, to use this library all you have to do is extract it somewhere, make
...@@ -137,13 +149,15 @@ sudo apt-get install libx11-dev ...@@ -137,13 +149,15 @@ sudo apt-get install libx11-dev
</p> </p>
<center><h1>Preprocessor Directives</h1></center> <br/>
<center><h1>Miscellaneous Preprocessor Directives</h1></center>
<p> <p>
There are a few preprocessor directives you can supply during the build process In addition to the preprocessor directives mentioned above, there
to cause the library to build in various optional ways. By default, the are a few more you can supply during the build process to cause the
library will always do something reasonable, but they are listed here in the library to build in various optional ways. By default, the library
event that you need to use them. will always do something reasonable, but they are listed here in
the event that you need to use them.
</p> </p>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment