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

Updated README with CMake instructions #14

Merged
merged 3 commits into from
Jan 10, 2024
Merged

Updated README with CMake instructions #14

merged 3 commits into from
Jan 10, 2024

Conversation

gha3mi
Copy link
Owner

@gha3mi gha3mi commented Jan 10, 2024

Refs #13

@gha3mi
Copy link
Owner Author

gha3mi commented Jan 10, 2024

Hi @jchristopherson,

I have updated the README based on the workflow you provided. Could you please review it to ensure the CMake instructions are accurate?

Thank you,
Ali

@gha3mi gha3mi added the documentation Improvements or additions to documentation label Jan 10, 2024
@jchristopherson
Copy link
Contributor

Hi @gha3mi

It can actually be much simpler. For a typical use case the default build is a Release build and fully optimized. A simple series of calls such as the following will suffice.

cd build
cmake ../build
make

This will configure and build. If tests are desired, then add -DBUILD_TESTING to the configuration step as follows.
cmake ../build -DBUILD_TESTING=TRUE

And then a simple call to make will suffice, as before.

@gha3mi
Copy link
Owner Author

gha3mi commented Jan 10, 2024

Thank you!

@gha3mi gha3mi merged commit 5158df7 into main Jan 10, 2024
9 checks passed
@gha3mi gha3mi deleted the cmake branch January 10, 2024 21:48
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