From 52cccb8ddadbfff338b627d4f8c654840be1840b Mon Sep 17 00:00:00 2001
From: Tomaka17 <pierre.krieger1708@gmail.com>
Date: Sat, 2 Aug 2014 20:49:48 +0200
Subject: [PATCH] Add doc to crate root

---
 src/lib.rs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index e238b15e..f38a4b8a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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::*;