Commit 517e64ee authored by Davis King's avatar Davis King

updated repo level readme file

parent fc486996
If you are reading this file then you must have downloaded dlib via the See http://dlib.net for the main project documentation.
mercurial repository. If you are new to dlib then go read the introduction
and how to compile pages at http://dlib.net/intro.html and http://dlib.net/compile.html.
If you are planning on contributing code then also read the contribution
instructions at http://dlib.net/howto_contribute.html.
COMPILING DLIB EXAMPLE PROGRAMS COMPILING DLIB 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. Note that there is nothing to install That will build all the examples. There is nothing to install when using
when using dlib. It's just a folder of source files. Sometimes people dlib. It's just a folder of source files.
tell me dlib should be compiled and installed as some kind of shared
library, however, they are wrong. Please read this http://dlib.net/howto_contribute.html#9
before starting this argument again.
RUNNING THE UNIT TEST SUITE RUNNING THE UNIT TEST SUITE
Type the following to compile and run the dlib unit test suite (it takes a while): Type the following to compile and run the dlib unit test suite:
cd dlib/test; mkdir build; cd build; cmake ..; cmake --build . --config Release; ./test --runall cd dlib/test
mkdir build
Note that on windows your compiler might put the test executable in a subfolder called cd build
Release. If that's the case then you have to go to that folder before running the test. cmake ..
cmake --build . --config Release
./test --runall
Note that on windows your compiler might put the test executable in a
subfolder called Release. If that's the case then you have to go to that
folder before running the test.
DOCUMENTATION DOCUMENTATION
The mercurial repository doesn't contain finished documentation. The stuff in The source control repository doesn't contain finished documentation. The
the docs folder is just a bunch of scripts and xml files used to generate the stuff in the docs folder is just a bunch of scripts and xml files used to
documentation. There is a readme in docs/README.txt which discusses how to do generate the documentation. There is a readme in docs/README.txt which
this. However, unless you are trying to modify the documentation, you should discusses how to do this. However, unless you are trying to modify the
just download a copy from http://dlib.net. That would probably be easier than documentation, you should just download a copy from http://dlib.net.
setting up your environment to generate the documentation yourself.
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