[Docs] Updated readme file for release
This commit is contained in:
Stefanos A.
parent
e02093bb90
commit
3b65e66958
1 changed files with 65 additions and 53 deletions
118
README.md
118
README.md
|
|
@ -1,66 +1,78 @@
|
|||
OpenTK
|
||||
======
|
||||
|
||||
|
||||
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 of the project:
|
||||
|
||||
https://github.com/opentk/opentk
|
||||
|
||||
|
||||
|
||||
Project website: http://www.opentk.com/
|
||||
|
||||
Official git repository: https://github.com/opentk/opentk
|
||||
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
- Create cutting-edge graphics with OpenGL 4.4 and OpenGL ES 3.0.
|
||||
|
||||
- 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.
|
||||
|
||||
- Use strong types and inline documentation to improve your code flow and catch errors sooner.
|
||||
|
||||
|
||||
|
||||
- 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
|
||||
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
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)
|
||||
|
||||
|
||||
|
||||
- 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
|
||||
=============
|
||||
|
||||
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)
|
||||
|
||||
|
||||
|
||||
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?
|
||||
==========
|
||||
|
||||
The community hangs out at the [OpenTK forums](http://www.opentk.com/forum)
|
||||
|
||||
If you hit a bug, post an issue on https://github.com/opentk/opentk/issues
|
||||
|
||||
|
||||
|
||||
Post your questions at the [OpenTK forums](http://www.opentk.com/forum).
|
||||
|
||||
Report bugs at https://github.com/opentk/opentk/issues
|
||||
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
The Open Toolkit is distributed under the permissive MIT/X11 license and is absolutely free.
|
||||
|
||||
The Open Toolkit is distributed under the permissive MIT/X11 license and is absolutely free.
|
||||
|
||||
http://www.opentk.com/project/license
|
||||
|
|
|
|||
Loading…
Reference in a new issue