Commit 5ba3c96e authored by Davis King's avatar Davis King

updated README

parent 7eab4ed0
dlib C++ library
See http://dlib.net for the main project documentation. Dlib is a modern C++ toolkit containing machine learning algorithms and tools
for creating complex software in C++ to solve real world problems. See
http://dlib.net for the main project documentation and API reference.
COMPILING DLIB EXAMPLE PROGRAMS COMPILING DLIB C++ EXAMPLE PROGRAMS
Go into the examples folder and type: Go into the examples folder and type:
mkdir build; cd build; cmake .. ; cmake --build . mkdir build; cd build; cmake .. ; cmake --build .
That will build all the examples. If you have a CPU that supports AVX
That will build all the examples. There is nothing to install when using instructions then turn them on like this:
dlib. It's just a folder of source files. mkdir build; cd build; cmake .. -DUSE_AVX_INSTRUCTIONS=1 ; cmake --build .
Doing so will make some things run faster.
COMPILING DLIB Python API
Before you can run the Python example programs you must compile dlib. Type:
python setup.py install
or type
python setup.py install --yes USE_AVX_INSTRUCTIONS
if you have a CPU that supports AVX instructions, since this makes some
things run faster.
RUNNING THE UNIT TEST SUITE RUNNING THE UNIT TEST SUITE
Type the following to compile and run the dlib unit test suite: Type the following to compile and run the dlib unit test suite:
...@@ -24,9 +36,12 @@ RUNNING THE UNIT TEST SUITE ...@@ -24,9 +36,12 @@ RUNNING THE UNIT TEST SUITE
subfolder called Release. If that's the case then you have to go to that subfolder called Release. If that's the case then you have to go to that
folder before running the test. folder before running the test.
DOCUMENTATION This library is licensed under the Boost Software License, which can be found
The source control repository doesn't contain finished documentation. The in dlib/LICENSE.txt. The long and short of the license is that you can use
stuff in the docs folder is just a bunch of scripts and xml files used to dlib however you like, even in closed source commercial software.
generate the documentation. There is a readme in docs/README.txt which
discusses how to do this. However, unless you are trying to modify the Dlib Sponsors:
documentation, you should just download a copy from http://dlib.net. This code development was funded by the Office of the Director of National
Intelligence (ODNI), Intelligence Advanced Research Projects Activity (IARPA),
via IARPA R&D Contract No. 2014-14071600010
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