Skip to content

Updated README Cmake relative paths to current directory #93

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

Closed
wants to merge 1 commit into from

Conversation

benjitrosch
Copy link

The current README's Cmake commands have relative paths that go up a directory with .. instead of using the current directory ., which seems to imply that the user is running the command while inside a folder—which is likely not the case.

Also, this would make the instructions match with https://github.com/xiph/vorbis.

@rillian
Copy link
Contributor

rillian commented Jul 7, 2025

Thanks for the patch.

Just above the first line you changed, the instructions say

    mkdir build
    cd build

So I think it's correct to write the following commands as if srcdir is one level above. Moreover, I thought using separate build directories was recommended practice for cmake?

One can stay in the source directory and pass the build directory on the command-line each time, but the options are inconsistent between cmake, cmake --build, and ctest so I find changing directory easier to follow.

@benjitrosch
Copy link
Author

Hmm, I can't say what I was thinking 2 years ago, but you are 100% correct. I'll close the PR, thanks!

@benjitrosch benjitrosch closed this Jul 7, 2025
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.

2 participants