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

Improve CMake docs #2564

Merged
merged 14 commits into from
Jul 28, 2022
Merged

Improve CMake docs #2564

merged 14 commits into from
Jul 28, 2022

Conversation

ZedThree
Copy link
Member

@ZedThree ZedThree commented Jul 27, 2022

Fixes #2563, #2558

We could really do with a short, clean, and obvious "quickstart" section.

@ZedThree ZedThree added this to the BOUT-5.0 milestone Jul 27, 2022
bendudson
bendudson previously approved these changes Jul 27, 2022
Copy link
Contributor

@bendudson bendudson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ZedThree !

@ZedThree
Copy link
Member Author

I've now also added some more details on common CMake options, how to build debug vs production, deleted some out of date bits, and fixed a bunch of formatting issues I noticed at the same time.

Copy link
Contributor

@bendudson bendudson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thanks @ZedThree

@ZedThree ZedThree merged commit 32afc20 into next Jul 28, 2022
@ZedThree ZedThree deleted the cmake-docs branch July 28, 2022 16:11
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

Successfully merging this pull request may close these issues.

None yet

2 participants