Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation incomplete #4

Closed
raarts opened this issue May 31, 2015 · 2 comments
Closed

Documentation incomplete #4

raarts opened this issue May 31, 2015 · 2 comments

Comments

@raarts
Copy link

raarts commented May 31, 2015

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
Copy link
Owner

PJK commented Jun 2, 2015

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
Copy link
Owner

PJK commented Dec 25, 2015

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

Thanks again 🎅

@PJK PJK closed this as completed Dec 25, 2015
PJK added a commit that referenced this issue Jan 6, 2017
PJK added a commit that referenced this issue Jan 10, 2017
PJK added a commit that referenced this issue Jan 11, 2017
PJK added a commit that referenced this issue Sep 30, 2017
PJK added a commit that referenced this issue Apr 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants