Include the caches explanation, move readme to markdown

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

Make it compile everything, use cmake.

Also force documentation rebuild.

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

wrong git repository, we moved to forward iterators
and we talked about encoding instead of decoding

Signed-off-by: Luker <luker@fenrirproject.org>

Use link time optimization with gcc and clang.

Also: add LTO to documentation, and warn that
clang and profiling break deterministic builds

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

lots of bugfixes, also due to the creation of a couple of examples
for the C and C++ interface. Updated documentation accordingly

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

Add the "tests" target and use lstlisting

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

Also small diff to documentation

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

Also, the C interface should return uint64, not uint32

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

The Gnu Free Documentation License seems better suited
to the documentation than the LGPL.

Also, start writing something about the C interface

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>

Also add relative (optional) cmake target: "docs"
Documentation is still incomplete, needs more
work.

Signed-off-by: Luca Fulchir <luker@fenrirproject.org>