summaryrefslogtreecommitdiffstats
path: root/dev/MinGfx/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dev/MinGfx/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/dev/MinGfx/README.md b/dev/MinGfx/README.md
new file mode 100644
index 0000000..c752eec
--- /dev/null
+++ b/dev/MinGfx/README.md
@@ -0,0 +1,15 @@
+# MinGfx Toolkit
+
+*Quick Links:*
+* [Documentation Main Page](https://ivlab.github.io/MinGfx/index.html)
+
+* [libMinGfx Installation Guide](https://ivlab.github.io/MinGfx/installation.html)
+* [Creating Your Own Graphics Program by Copying an Example](https://ivlab.github.io/MinGfx/installation.html#example)
+* [API Organized by Topic](https://ivlab.github.io/MinGfx/api.html)
+* [Source on GitHub](https://github.com/ivlab/MinGfx)
+
+
+*Project Overview:*
+The MinGfx Toolkit is a minimal library for writing cross-platform (Windows, OSX, linux) graphics programs with modern OpenGL 3.3+ support. Application programmers should subclass from MinGfx::GraphicsApp, which provides callbacks for several styles of rendering and user interfaces. On-screen graphical user interfaces can be created with built-in support for NanoGUI. 2D vector graphics rendering is supported by linking with NanoVG. 3D graphics rendering is supported via MinGfx::Mesh, MinGfx::Shader, MinGfx::Texture2D, and related classes. Additionally, application programmers can do whatever custom 2D or 3D rendering is needed with direct calls to OpenGL.
+
+The library is maintained by Prof. Daniel Keefe (dfk@umn.edu) and is used for instructional purposes in UMN computer science courses (CSci-4611, CSci-3081W, ...) as well as some research projects. See LICENSE.txt for additional details.