search

PJK / libcbor

CBOR protocol implementation for C
MIT License
340 stars 95 forks source link

Documentation incomplete #4

Closed raarts closed 8 years ago

raarts commented 9 years ago

The docs do not mention the cmocka dependency in the Building & Installing Prerequisites. Also for cmake-newbies like me it would be nice to clarify the '# Assuming you are in the directory where you want to build' comment. I did not know where I wanted to build.. Turns out cmake expects you to create a build directory, and then run:

cmake -DCMAKE_BUILD_TYPE=Release ../

Just trying to smoothen the onboarding here ;-)

PS: I also added -DCMAKE_INSTALL_PREFIX:PATH=$HOME to the cmake commandline, since I don't want to actually install each library I try out. You may want to clarify that root permissions are not really required for installation.

PJK commented 9 years ago

Thanks for the feedback, I'll address it soon. If you know of any reasonably complete yet succinct reference for cmake, linking to it from the docs would probably be quite useful

PJK commented 8 years ago

The current state of the documentation seems to reflect all the issues that you pointed out (f7c5329).

Thanks again :santa: