aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomaka17 <pierre.krieger1708@gmail.com>2014-09-15 13:46:37 +0200
committerTomaka17 <pierre.krieger1708@gmail.com>2014-09-15 13:46:37 +0200
commit661c936253bda31e5457cb74eca85d37582f0717 (patch)
treeb35747e89422f04638107cb3020f4b72ca1fda4c
parent991dc50a319cd2083da82a8c49153ef5adb54490 (diff)
downloadglutin-661c936253bda31e5457cb74eca85d37582f0717.tar.gz
glutin-661c936253bda31e5457cb74eca85d37582f0717.zip
Add platform-specific notes in README
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6c96e54..1dd1ae5 100644
--- a/README.md
+++ b/README.md
@@ -36,3 +36,31 @@ fn main() {
}
}
```
+
+## Platform-specific notes
+
+### Android
+
+ - To compile the examples for android, initialize the submodules, go to `deps/apk-builder/apk-builder` and run `cargo build`, then go back to `gl-init` and call `ANDROID_HOME=/path/to/sdk NDK_HOME=/path/to/ndk NDK_STANDALONE=/path/to/standalone cargo test --no-run --target=arm-linux-androideabi`
+ - Events are not implemented
+
+### Emscripten
+
+ - Work will start when Emscripten gets updated to LLVM 3.5 (which should happen soon)
+
+### OS/X
+
+ - This library compiles for OS/X but calling any function will fail
+ - Some low-level issues related to Objective C bindings make the implementation difficult to write
+ - Looking for contributors
+
+### Win32
+
+ - Pixel formats are not implemented
+ - If you don't have MinGW installed, you will need to provide `libgdi32.a` and `libopengl32.a` ; you can put them in `C:\Users\you\.rust`
+
+### X11
+
+ - Some input events are not implemented
+ - Pixel formats not implemented
+ - The implementation probably needs a cleanup