diff options
author | Tomaka17 <pierre.krieger1708@gmail.com> | 2014-08-02 20:49:48 +0200 |
---|---|---|
committer | Tomaka17 <pierre.krieger1708@gmail.com> | 2014-08-02 20:49:48 +0200 |
commit | 52cccb8ddadbfff338b627d4f8c654840be1840b (patch) | |
tree | 89efb1071abac678d988a40083e1c721e906250d /src | |
parent | ed3ed47ad88c628db81bcb3ee4f9106473844893 (diff) | |
download | glutin-52cccb8ddadbfff338b627d4f8c654840be1840b.tar.gz glutin-52cccb8ddadbfff338b627d4f8c654840be1840b.zip |
Add doc to crate root
Diffstat (limited to 'src')
-rw-r--r-- | src/lib.rs | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -2,6 +2,21 @@ #![feature(globs)] #![unstable] +//! The purpose of this library is to provide an OpenGL context on as many +//! platforms as possible. +//! +//! # Building a window +//! +//! There are two ways to create a window: +//! +//! - Calling `Window::new()`. +//! - Calling `let builder = WindowBuilder::new()` then `builder.build()`. +//! +//! The first way is the simpliest way and will give you default values. +//! +//! The second way allows you to customize the way your window and GL context +//! will look and behave. + extern crate libc; pub use events::*; |