Information on how to get SDL2 working on OSX

[bvssvni]

If you don't have brew installed, see #177

This solution is relevant if you get an long error message when running cargo build ending in:

ld: library not found for -lSDL2

Lacking permission to link SDL2

On some computers, the brew command fails to create the symlinks to the libraries it installs. This means the Rust compiler can not find them. To get permission to do this, use the chown command as following:

brew install sdl2
sudo chown root:wheel /usr/local/bin/brew
brew unlink sdl2 && brew link sdl2

Missing path in LIBRARY_PATH environment variable

The Homebrew package manager symlinks library to the directory /usr/local/lib. To use these libraries with Rust, you need to add it to the LIBRARY_PATH environment variable. The command echo $LIBRARY_PATH will tell you if /usr/local/lib is added. If it is missing, add the following to the ~/.bash_profile configuration file:

export LIBRARY_PATH="$LIBRARY_PATH:/usr/local/lib"

This will add the directory to the environment variable each time you start up a new Terminal window.

M1 Hardware

This solution was suggested by #175 (comment)

export LIBRARY_PATH="$LIBRARY_PATH:/opt/homebrew/lib

[golergka]

I've just spend about 2 hours troubleshooting this issue... Could it be linked somewhere from README file?

[indiv0]

@bvssvni I think that @golergka's suggestion is reasonable, but maybe we should compile a caveats.md or similar for FAQs and common issues?

[bvssvni]

@golergka I opened up an issue on the sdl2_game_window repo. PistonDevelopers/sdl2_window#72
It is already linked from the README in rust-sdl2

[subhashb]

👍
Can even link this issue in piston-examples README. That's where most people starting with Piston will land up.

Let me know if you want me to raise a PR.

[bvssvni]

@subhashb Please do.

[subhashb]

@bvssvni Here goes: PistonDevelopers/piston-examples#92

[rofrol]

On ubuntu 14.10:

apt-get install libsdl2-dev

brew install sdl2

worked fine for me. I didn't take any other actions. Consider editing the info. here.

[OpenUAS]

@rofrol ..Hmm was the OSX part in the description not obvious ;)