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.

Sign up for GitHub

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

Correct compilation instructions for *nix #2026

Closed
wants to merge 3 commits into from
Closed

Correct compilation instructions for *nix #2026

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b424cd0
Correct compilation instructions for *nix
akkartik Feb 26, 2024
327b638
code-review suggestion to compilation instructions
akkartik Feb 26, 2024
f251ba3
improve wording before compilation instructions
akkartik Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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:


$ platform/unix/automagic
$ ./configure
$ make

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/`.
Copy link

Choose a reason for hiding this comment

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

build and prefix folders will popup as untracked files in git repository. Is it ok ?

Copy link

Choose a reason for hiding this comment

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

cmake -S. also implies that we run these commands from the repository root. Probably we should explicitly mention it

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link

Choose a reason for hiding this comment

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

As I see in CMakeLists.txt, you can't run cmake -B. -S., but it should be ok for cmake -Bbuild -S.


### macOS
Download or clone [this repository][dependencies-apple] and copy, move, or symlink the `macOS/Frameworks` subfolder into love's `platform/xcode/macosx` folder.
Expand Down
Loading