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.

Sign up for GitHub

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

Jump to bottom

Provide more documentation on CMake configurations #5

Closed
saminarp opened this issue Sep 16, 2022 · 3 comments
Closed

Provide more documentation on CMake configurations #5

saminarp opened this issue Sep 16, 2022 · 3 comments
Assignees
@batunpc

Comments

@saminarp
Copy link
Contributor

Provide more explanations about CMake configurations. For example, what does the config folder actually do? And how does CMake help you to configure external dependencies? This could make your README more powerful and help users a lot!
@batunpc batunpc self-assigned this Sep 16, 2022
@batunpc
Copy link
Owner

batunpc commented Sep 16, 2022

Thank you for the review! config directory is responsible with the versioning of the project. Instead of manually typing we can retrieve the version from config.hpp file. It's a nice feature by CMake. I will update the readme accordingly! 👍

@batunpc
Copy link
Owner

batunpc commented Sep 16, 2022 •
edited
Loading

I have added concise but descriptive explanation on how I have handled this in the end of my readme. Let me know if it looks enough. I am thinking to write more details in the blog regarding documentation

@saminarp
Copy link
Contributor Author

Great. Looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@batunpc batunpc

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@batunpc @saminarp