Opentk/README.md

79 lines
2.8 KiB
Markdown
Raw Normal View History

2013-03-07 01:26:55 +00:00
OpenTK
======
2014-01-15 13:16:00 +00:00
2013-11-12 10:24:25 +00:00
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.
2014-01-15 13:16:00 +00:00
Project website: http://www.opentk.com/
Official git repository: https://github.com/opentk/opentk
2013-11-12 01:03:24 +00:00
Features
========
2014-01-15 13:16:00 +00:00
- Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0
- Spice up your GUI with 3d graphics
- Improve your code flow with strong types and inline documentation
- Write once run everywhere!
OpenTK is available on Windows, Linux, Mac OS X, *BSD, SteamOS, Android and iOS. It can be used standalone or integrated into a GUI (Windows.Forms, WPF, GTK+, Qt, VTK, ...)
Binaries and NuGet packages available at http://www.opentk.com
Roadmap
=======
- Merge opentk/opentk (upstream) with mono/opentk (Xamarin)
- Add Portable Class Library (PCL) target
- Add multitouch API
- Add new platforms: NaCL, emscripten, Windows Metro, Ouya, Raspberry PI
- Improve OpenCL bindings
- Improve math library
Contributing
============
1. Install git and a C# IDE (see requirements section below)
2. Fork the _develop_ branch of https://github.com/opentk/opentk
3. Commit your changes in small, incremental steps with clear descriptions
4. When ready, issue a Pull Request (PR) against the _develop_ branch of https://github.com/opentk/opentk
For details on coding style and best practices, refer to https://github.com/opentk/opentk/wiki/Contributing
2013-11-12 10:24:25 +00:00
Requirements
============
2014-01-15 13:16:00 +00:00
- Windows (XP/Vista/7/8), Linux, Mac OS X, *BSD, SteamOS, Android or iOS
- For graphics, OpenGL drivers or a suitable emulator, such as [ANGLE](https://github.com/opentk/opentk/tree/Dependencies/Readme.txt)
- For audio, OpenAL drivers or [OpenAL Soft](https://github.com/opentk/opentk/tree/Dependencies/Readme.txt)
- To develop desktop applications: Visual Studio, Xamarin Studio, MonoDevelop or SharpDevelop
- To develop Android applications: Xamarin Studio or the Xamarin Extensions for Visual Studio
- To develop iOS applications: Xamarin Studio and XCode
Documentation
=============
2014-01-15 13:16:00 +00:00
Your favorite IDE will display inline documentation for all OpenTK APIs. Additional information can be found in the [OpenTK Manual](http://www.opentk.com/doc) and in the [opentk/Documentation/](https://github.com/opentk/opentk/tree/develop/Documentation) folder.
Technical documentation about the implementation of OpenTK can be found in the [Technical Wiki](https://github.com/opentk/opentk/wiki).
Need Help?
==========
2014-01-15 13:16:00 +00:00
Post your questions at the [OpenTK forums](http://www.opentk.com/forum).
Report bugs at https://github.com/opentk/opentk/issues
2013-11-12 10:24:25 +00:00
License
=======
2014-01-15 13:16:00 +00:00
The Open Toolkit is distributed under the permissive MIT/X11 license and is absolutely free.
http://www.opentk.com/project/license