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

Add how to install guide #15

Merged
merged 20 commits into from
Feb 11, 2025
Merged

Add how to install guide #15

merged 20 commits into from
Feb 11, 2025

Conversation

aedart
Copy link
Contributor

@aedart aedart commented Feb 10, 2025

PR adds installation guide.

Note

During local / manual installation tests, a sever issue was discovered. When installing this package via CPM, the rsp/* modules were not made available. For now, the guide entails how clients can manually append our modules, to make them work, when installing via CPM.

References

See cpm-cmake/CPM.cmake#532 for additional details.

aedart added 20 commits February 7, 2025 15:01
Not sure why CPM does not want to include the modules, but this needs to be resolved asap.
No need to pollute the console with too many messages.
Didn't know about PROJECT_IS_TOP_LEVEL
This part simply will not work, when any kind of package installation is wrapped inside a cmake function, due to cmake's variable scope. It is pure luck that our `FetchContent_Declare` example works.
For now, this acts as a test to see how both cmake's FetchContent module and CPM treats it.
For now, this is a test of the configuration mechanism, to see how cmake's FetchContent module and CPM treats it.
This is needed or the GNUInstallDirs module isn't going to work as intended.
This reverts commit 6e0a0ef.

Had no effect on the config file's state of being read by the consuming client project. Thus, the GNUInstallDirs are not needed!
Not sure if this is going to work without the "targets" part, but example code looks more promising that previous.
Not sure about this, but seems that both CPM and find_package() uses this path to search for the configuration files first.
This failed, and there seems to be no good way around it. Consuming packages MUST manually append to their CMAKE_MODULE_PATH.
@aedart aedart added the documentation Improvements or additions to documentation label Feb 10, 2025
@aedart aedart requested a review from kernelguy February 10, 2025 14:44
@aedart aedart self-assigned this Feb 10, 2025
@aedart aedart merged commit 1f51e73 into main Feb 11, 2025
4 checks passed
@aedart aedart deleted the add-how-to-install-guide branch February 11, 2025 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants