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

doc: Improve cmake instructions in README #1641

Closed
wants to merge 1 commit into from

Conversation

fjahr
Copy link

@fjahr fjahr commented Nov 26, 2024

Minor improvement suggestion for the readme. I find this alternative way of using cmake a bit more comfortable because I don't like to change the directory.

It's just a suggestion based on personal preference, if this is too minor of an improvement feel free to close.

@real-or-random
Copy link
Contributor

I happen to find this a tiny bit more comfortable, too, but IIRC we had discussed this (I can't find the discussion) and @hebasto argued that the tutorial cds into the build directory. I also think that mkdir build && cd build is a bit more self-documentary to people not familiar with CMake because it makes clear that build is a directory and not some CMake command or something.

No strong opinion from my side, but I think there are good reasons for what we have currently.

@fjahr
Copy link
Author

fjahr commented Nov 28, 2024

@real-or-random alright, thanks for the info, closing it for now

@fjahr fjahr closed this Nov 28, 2024
@hebasto
Copy link
Member

hebasto commented Nov 28, 2024

FWIW, while working on the CMake staging branch for Bitcoin Core, the rough consensus has been reached not to suggest using cd in the build docs (see https://github.com/bitcoin/bitcoin/blob/master/doc/build-*.md).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build user-documentation user-facing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants