mirror of
https://github.com/rust-windowing/winit.git
synced 2026-09-01 14:20:05 -04:00
Add doc to crate root
This commit is contained in:
15
src/lib.rs
15
src/lib.rs
@@ -2,6 +2,21 @@
|
|||||||
#![feature(globs)]
|
#![feature(globs)]
|
||||||
#![unstable]
|
#![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;
|
extern crate libc;
|
||||||
|
|
||||||
pub use events::*;
|
pub use events::*;
|
||||||
|
|||||||
Reference in New Issue
Block a user