Correct compilation instructions for *nix #2026
Conversation
It looks like the old `automagic` file is no longer in the repo.
Co-authored-by: Miku AuahDark <auahdark687291@gmail.com>
|
How does this look? |
|
I'm still not too positive with the wording at "First pick a directory to store generated files to, say |
|
Yeah, I'm not attached to it. Feel free to suggest something. Do you want it to be more explicit? Basically my thinking/preference was the commands are already saying what to do. But happy to add whatever you like. |
|
|
||
| When using a source release, automagic has already been run, and the first step can be skipped. | ||
| $ cmake -B build -S. --install-prefix $PWD/prefix # this will create the directory `build/` | ||
| $ cmake --build build --target install # this will put the files in `prefix/`. |
There was a problem hiding this comment.
build and prefix folders will popup as untracked files in git repository. Is it ok ?
There was a problem hiding this comment.
cmake -S. also implies that we run these commands from the repository root. Probably we should explicitly mention it
There was a problem hiding this comment.
Hmm, you're right. The autotools build system used to allow in-tree build. With the transition to CMake, we explicitly forbid in-tree build.
There was a problem hiding this comment.
As I see in CMakeLists.txt, you can't run cmake -B. -S., but it should be ok for cmake -Bbuild -S.
| @@ -54,13 +54,10 @@ Compilation | |||
| Follow the instructions at the [megasource][megasource] repository page. | |||
|
|
|||
| ### *nix | |||
| Run `platform/unix/automagic` from the repository root, then run ./configure and make. | |||
| First pick a directory to store generated files to, say `build/` and then: | |||
There was a problem hiding this comment.
| First pick a directory to store generated files to, say `build/` and then: | |
| Because in-tree builds are not allowed, you have to create Makefiles in a build folder. | |
| In this example we will use the `build/` folder: |
|
I opted slightly different text based on this PR. Thanks. |
It looks like the old
automagicfile is no longer in the repo.