Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
dlib
Commits
3e674f01
Commit
3e674f01
authored
May 20, 2012
by
Davis King
Browse files
Added readme to base of mercurial repository.
parent
a17178eb
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
35 additions
and
0 deletions
+35
-0
README.txt
README.txt
+35
-0
No files found.
README.txt
0 → 100644
View file @
3e674f01
If you are reading this file then you must have downloaded dlib via the
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
go into the examples folder and type:
mkdir build; cd build; cmake .. ; cmake --build .
That will build all the examples. Note that there is nothing to install
when using dlib. It's just a folder of source files. Sometimes people
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
Type the following to compile and run the dlib unit test suite (it takes a while):
cd dlib/test; mkdir build; cd build; 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
The mercurial repository doesn't contain finished documentation. The stuff in
the docs folder is just a bunch of scripts and xml files used to 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 documentation, you should
just download a copy from http://dlib.net. That would probably be easier than
setting up your environment to generate the documentation yourself.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment