From 86570bd1414adc16dba546c2cc2504274c9ba1a7 Mon Sep 17 00:00:00 2001 From: shivshank Date: Tue, 24 Jul 2018 18:34:13 -0400 Subject: [PATCH] Finish doc comment I don't know why I have a tendency to forget writing docs... while mid writing docs! --- Cargo.toml | 2 +- src/lib.rs | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 9897193..c0fbfc7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mini_gl_fb" -version = "0.2.1" +version = "0.2.2" authors = ["shivshank"] [dependencies] diff --git a/src/lib.rs b/src/lib.rs index ea4c158..51c92ed 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,13 @@ //! Hardware accelerated library inspired by minifb and friends. //! -//! Powered by OpenGL. Default context is provided by glutin, but +//! Powered by OpenGL. Default context is provided by glutin, but this may be optional in the +//! future so that you can create your own context any way you like. +//! +//! # Note on possible context creation failure: +//! +//! Currently uses the `gl` crate for OpenGL loading. OpenGL context creation may fail if your +//! setup does not support the newest OpenGL. This bug needs to be verified and is be fixable. +//! OpenGL ~3 is currently required, but OpenGL 2.1 support should be feasible if requested. extern crate glutin; #[macro_use]