diff --git a/README.md b/README.md index c61b3e9e..954425db 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,66 @@ OpenTK ====== -The Open Toolkit is an advanced, low-level C# library that wraps OpenGL and OpenAL. It is suitable for games, scientific applications and any other project that requires 3d graphics, audio or compute functionality. +The Open Toolkit is an advanced, low-level C# library that wraps OpenGL, OpenGL ES and OpenAL. It is suitable for games, scientific applications and any other project that requires 3d graphics, audio or compute functionality. -This is the official GIT repository for the project. +This is the official GIT repository of the project: + +https://github.com/opentk/opentk Features ======== -Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0. +- Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0. -Integrate 3d into Windows.Forms, WPF or GTK# applications. +- Integrate 3d into Windows.Forms, WPF or GTK# applications. -Write once run everywhere: support for Windows, Mac OS X, Linux, Xamarin.Android and Xamarin.iOS. +- Write once run everywhere: support for Windows, Mac OS X, Linux, Xamarin.Android and Xamarin.iOS. -Use strong types and inline documentation to improve your code flow and catch errors sooner. +- Use strong types and inline documentation to improve your code flow and catch errors sooner. -License -======= +Requirements +============ -The Open Toolkit is distributed under the permissive MIT/X11 license and is absolutely free. +OpenTK is designed to be used in an IDE with auto-completion and documentation tooltips: +- Visual Studio 2005 or higher +- Xamarin Studio 2.x or higher +- MonoDevelop 2.x or higher +- SharpDevelop 3.x or higher + +You can develop on your favorite operating system. Compiled binaries can be deployed without recompilation on: +- Windows +- Linux +- Mac OS X + +For: +- Android +- iOS +you will need to recompile your code with Xamarin (http://xamarin.com/download) Documentation ============= -The best source of documentation is the [OpenTK Manual](http://www.opentk.com/doc) +The Documentation/ folder contains extensive documentation on OpenGL, OpenGL ES and OpenAL. Start with these: + +- OpenGL 4.4 API Reference.pdf +or +- OpenGL ES 3.0 API Reference.pdf + +Your favorite IDE will display inline documentation for all OpenTK APIs. Tutorials can be found in the [OpenTK Manual](http://www.opentk.com/doc) Need Help? ========== -Feel free to post an issue on github. +The community hangs out at the [OpenTK forums](http://www.opentk.com/forum) -Alternatively, head over to the [OpenTK forums](http://www.opentk.com/forum). \ No newline at end of file +If you hit a bug, post an issue on https://github.com/opentk/opentk/issues + + +License +======= + +The Open Toolkit is distributed under the permissive MIT/X11 license and is absolutely free. \ No newline at end of file