aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortomaka <pierre.krieger1708@gmail.com>2015-05-04 16:11:32 +0200
committertomaka <pierre.krieger1708@gmail.com>2015-05-04 16:11:32 +0200
commit555dc648b73ae78c87b5a3da5fc2795f717f1e27 (patch)
treec073b7cdb004e634225f166336cc6ff9cf0c4e7a
parent01007dbfd4b5f98a03b660e9c76f1d01fb78cd22 (diff)
parente577995fc88a9fc114f17f5b7a7d3f781af324da (diff)
downloadglutin-555dc648b73ae78c87b5a3da5fc2795f717f1e27.tar.gz
glutin-555dc648b73ae78c87b5a3da5fc2795f717f1e27.zip
Merge pull request #424 from tomaka/tomaka-patch-1
Update the README
-rw-r--r--README.md29
1 files changed, 5 insertions, 24 deletions
diff --git a/README.md b/README.md
index 678f3d8..4d2e5d4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# glutin - OpenGL, UTilities and INput
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/tomaka/glutin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![](http://meritbadge.herokuapp.com/glutin)](https://crates.io/crates/glutin)
+
Alternative to GLFW in pure Rust.
[![Build Status](https://travis-ci.org/tomaka/glutin.png?branch=master)](https://travis-ci.org/tomaka/glutin)
@@ -11,13 +13,6 @@ Alternative to GLFW in pure Rust.
glutin = "*"
```
-Note that the crates.io version won't compile on OS/X and Android because the required dependencies haven't been uploaded yet. Instead you can use the git version which works everywhere:
-
-```toml
-[dependencies.glutin]
-git = "https://github.com/tomaka/glutin"
-```
-
## [Documentation](http://tomaka.github.io/glutin/)
## Try it!
@@ -64,32 +59,18 @@ fn main() {
}
```
+Note that glutin aims at being a low-level brick in your rendering infrastructure. You are encouraged to write another layer of abstraction between glutin and your application.
+
## 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 `glutin` 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 and vsync are not implemented
- - Headless rendering doesn't work
-
-### Emscripten
-
- - Work will start when Emscripten gets updated to LLVM 3.5 (which should happen soon)
-
-### OS/X
-
- - Some events are not implemented
- - Implementation is still work-in-progress
- - Vsync not implemented
### Win32
- You must call `glFlush` before `swap_buffers`, or else on Windows 8 nothing will be visible on the window
- - Changing the cursor (set_cursor) is not implemented
### X11
- - Some input events are not implemented
- - Pixel formats not implemented
- - Vsync not implemented
- - Not all mouse cursors are implemented (ContextMenu, ...)
+ - The plan is that glutin tries to dynamically link-to and use wayland if possible. If it doesn't work, it will try xlib instead. If it doesn't work, it will try libcaca. This is work-in-progress.