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

Update README.md #295

Merged
merged 5 commits into from
May 24, 2024
Merged

Update README.md #295

merged 5 commits into from
May 24, 2024

Conversation

HomesGH
Copy link
Contributor

@HomesGH HomesGH commented Mar 7, 2024

Description

The cmake section in the README.md file was revised and updated. A list of compiler commands was added for easy lookup.

As cmake is the recommended way of building, its position was changed to be before the instructions regarding make.

Improve cmake section in README
@HomesGH HomesGH requested a review from cniethammer March 7, 2024 12:02
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@HomesGH HomesGH requested a review from FG-TUM March 7, 2024 12:46
FG-TUM
FG-TUM previously approved these changes Mar 7, 2024
Copy link
Member

@FG-TUM FG-TUM left a comment

Choose a reason for hiding this comment

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

Overall I'm fine with the changes, but if you are really motivated to give this some polish I think we should focus less on "here are 5 alternatives to do X" and focus more on one way:

mkdir build
cd build
CC=clang CXX=clang++ ccmake ..
make -j $(nproc)

Meaning maybe shorten the core explanations a bit to the essence.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@HomesGH HomesGH requested review from amartyads and FG-TUM March 20, 2024 15:39
FG-TUM
FG-TUM previously approved these changes Mar 20, 2024
@HomesGH HomesGH requested review from cniethammer and removed request for cniethammer March 20, 2024 16:34
@HomesGH HomesGH merged commit 269b91e into master May 24, 2024
52 checks passed
@HomesGH HomesGH deleted the update-README branch May 24, 2024 09:25
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.

4 participants