Skip to content

Commit c1c007f

Browse files
authored
Update README.md to merge "Bundled" section Codeblocks
Before this commit, there were separate instructions for build.rs in the section for the feature `bundled` on macos and linux but now there is a single merged build script that uses rust's conditional compilation features to merge the 2 codeblocks into 1 universal codeblock. None of the two codeblocks run if the operating system is windows or other.
1 parent 3aeeefc commit c1c007f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ SDL2 >= 2.0.8 is recommended to use these bindings, but note that SDL2 >= 2.0.5
4343

4444
Since 0.31, this crate supports a feature named "bundled" which compiles SDL2 from source and links it automatically. While this should work for any architecture, you **will** need a C compiler (like `gcc`, `clang`, or MS's own compiler) to use this feature properly.
4545

46-
By default, macOS and Linux only load libraries from system directories like `/usr/lib`. If you wish to distribute the newly built libSDL2.so/libSDL2.dylib alongside your executable, you will need to add rpath to your executable. Add the following line to `build.rs` script:
46+
By default, macOS and Linux only load libraries from system directories like `/usr/lib`. If you wish to distribute the newly built libSDL2.so/libSDL2.dylib alongside your executable, you will need to add rpath to your executable. Add the following lines to `build.rs` script:
4747
* on macOS:
4848
```rust
49-
println!("cargo:rustc-link-arg=-Wl,-rpath,@loader_path");
50-
```
51-
* on Linux:
52-
```rust
53-
println!("cargo:rustc-link-arg=-Wl,-rpath,$ORIGIN");
49+
[cfg(target_os="macos")]
50+
println!("cargo:rustc-link-arg=-Wl,-rpath,@loader_path");
51+
52+
[cfg(target_os="linux")]
53+
println!("cargo:rustc-link-arg=-Wl,-rpath,$ORIGIN");
5454
```
5555

5656
### Linux

0 commit comments

Comments
 (0)