[Doc] Updated documentation for release

Documentation/Instructions.txt

@@ -19,12 +19,21 @@ For more details, refer to http://www.opentk.com/doc
 
 === Build instructions ===
 
-Use OpenTK.sln to build the library. You can use Visual Studio 2010+, SharpDevelop 3.0+, MonoDevelop 2.0+ or Xamarin Studio.
+Double-click OpenTK.sln to build using Visual Studio 2010+, SharpDevelop 3.0+, MonoDevelop 2.0+ or Xamarin Studio.
 
 You can also build from the commandline using:
-
+(.Net)
 msbuild OpenTK.sln /p:Configuration=Release
-- or -
+(Mono)
 xbuild OpenTK.sln /p:Configuration=Release
 
-The resulting binaries will be placed under the Binaries/OpenTK/[Release|Debug] folders.
+The resulting binaries will be placed under the Binaries/OpenTK/[Release|Debug] folders.
+
+
+=== Troubleshooting ===
+
+When building with MonoDevelop you may encounter an issue regarding a missing “GlobalAssemblyInfo.cs” file. This file is normally generated as a pre-build event, via the “Build.UpdateVersion” project. There are two solutions to this issue:
+1. Configure MonoDevelop to use xbuild as its build system.
+2. Right-click and run “Build.UpdateVersion” manually.
+
+Older versions of xbuild may produce the same error when building from the commandline. In that case, simply execute xbuild twice - the second run should succeed.

Documentation/License.txt

@@ -1,6 +1,6 @@
 The Open Toolkit library license
 
-Copyright (c) 2006 - 2013 Stefanos Apostolopoulos <stapostol@gmail.com> for the Open Toolkit library.
+Copyright (c) 2006 - 2014 Stefanos Apostolopoulos <stapostol@gmail.com> for the Open Toolkit library.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Documentation/Release.txt

@@ -1,28 +1,32 @@
 The Open Toolkit 1.1
-22 November 2013
+15 February 2014
 
+http://www.opentk.com
+https://github.com/opentk/opentk
 
 
 [Overview]
 
-This is a beta release for OpenTK 1.1
+This is the first stable release for OpenTK 1.1
 
-New in OpenTK 1.1:
+New features:
-- support for OpenGL 4.4 and OpenGL ES 3.0
+1. support for OpenGL 4.4 and OpenGL ES 3.0
-- strongly-typed enums for OpenGL ES 2.0 and 3.0
+2. strongly-typed enums for OpenGL ES 2.0 and 3.0
-- inline documentation for all OpenGL and OpenGL ES core functions
+3. new, faster OpenGL bindings based on hand-optimized IL
-- a new SDL2 backend for improved platform compatibility
+4. a new SDL2 backend for improved platform compatibility
-- a greatly expanded math library
+5. new Joystick and GamePad APIs under OpenTK.Input
-- numerous bugfixes for Mac OS X, Windows 8 and Linux
+6. improved startup time and reduced memory consumption
-- ANGLE support for Windows systems without OpenGL drivers
+7. inline documentation for all OpenGL and OpenGL ES core functions
-- Support for Retina / high-DPI monitors
+8. a greatly expanded math library
+9. numerous bugfixes for Mac OS X, Windows 8 and Linux
+10. ANGLE support for Windows systems without OpenGL drivers
+11. support for Retina / high-DPI monitors
+12. monolinker can now be used to reduce the size of OpenTK.dll
+13. precompiled binaries for optional dependencies (OpenAL, SDL2, monolinker)
 
-All users are strongly encouraged to upgrade to OpenTK 1.1
+Users of previous versions are strongly encouraged to upgrade to OpenTK 1.1
 
-
+Visit http://www.opentk.com for the latest news and information on the Open Toolkit library.
-Visit http://www.opentk.com for the latest news and information on the Open Toolkit library
-
-Download the source code at https://github.com/opentk/opentk
 
 
 
@@ -36,58 +40,52 @@ Please refer to the following pages:
 
 [Known issues]
 
-- [all] The size of OpenTK.dll can be reduced.
-
-- [all] GamePad API throws NotImplementedException.
-
 - [all] Keyboard API exposes ushort parameter.
 
-- [SDL] does not support ChangeResolution API.
+- [SDL2] does not support OpenTK.GLControl.
 
-- [SDL] does not support multiple keyboards/mice.
+- [Mac/Carbon] does not support Retina resolutions. Please use the SDL2 backend instead.
 
-- [SDL] does not support GLControl.
+- [Mac/Carbon] does not support OpenGL 3.x/4.x. Please use the SDL2 backend instead.
-
-- [Mac/Carbon] does not support Retina resolutions. Please use the SDL backend instead.
 
 
 
 [Report an issue]
-If you encounter an issue, please report it at:
-https://github.com/opentk/opentk/issues
 
-Highest priority will be given to regressions from OpenTK 1.0
+If you encounter an issue with OpenTK, please report it at https://github.com/opentk/opentk/issues
+
+DonÕt forget to mention your operating system and GPU! If possible, try to attach a small, self-contained test case that reproduces the bug.
 
 
 
 [API compatibility]
 
-The vast majority of projects will be able to upgrade to OpenTK 1.1 without any modifications. However, due to updates in the official OpenGL specification and due to bugfixes in the binding generator, a number of OpenGL signatures have changed between OpenTK 1.0 and 1.1. 
+Most projects will be able to upgrade to OpenTK 1.1 without any modifications. However, due to updates in the official OpenGL specification and due to bugfixes in the binding generator, a number of OpenGL signatures have changed between OpenTK 1.0 and 1.1. 
 
 Modified signatures have been marked with the [Obsolete] attribute. A warning message will be generated with instructions on a suggested replacement.
 
-In a small number of cases, using the original signature would lead to incorrect results or a crash. These cases will generate a compiler error now. If you use any of the following signatures, please apply the suggested modification:
+In a small number of cases, using the original signature would lead to incorrect results or a crash. These cases will generate a compile-time error now. If you use any of the following signatures, please apply the suggested modification:
 
 Namespace OpenTK.Graphics.OpenGL
 Change signature:
-- GL.MultiDrawArrays (“out” -> “ref”)
+- GL.MultiDrawArrays (`out` -> `ref`)
-- GL.Amd.DeletePerfMonitors (“out” -> “ref”)
+- GL.Amd.DeletePerfMonitors (`out` -> `ref`)
 
 Change signature (may cause crash): 
-- GL.Apple.ObjectPurgeable (returns “AppleObjectPurgeable” instead of “IntPtr”)
+- GL.Apple.ObjectPurgeable (returns `AppleObjectPurgeable` instead of `IntPtr`)
 - GL.Ext.SeparableFilter2D
-- GL.Ibm.EdgeFlagPointerList (“bool[]” -> “bool*[]”)
+- GL.Ibm.EdgeFlagPointerList (`bool[]` -> `bool*[]`)
-- GL.NV.TransformFeedbackVaryings (“string[]” -> “int[]”)
+- GL.NV.TransformFeedbackVaryings (`string[]` -> `int[]`)
 
 Change return type:
-- GL.WaitSync (returns “WaitSyncFlags” instead of “ArbSync”)
+- GL.WaitSync (returns `WaitSyncFlags` instead of `ArbSync`)
 
 
 Namespace OpenTK.Graphics.ES11
 Change return type:
-- GL.GetError (“ErrorCode” instead of “All”)
+- GL.GetError (`ErrorCode` instead of `All`)
 
-Change “ref” parameters to “out”:
+Change `ref` parameters to `out`:
 - GL.GenBuffers
 - GL.GenTextures
 - GL.GetBoolean
@@ -130,7 +128,7 @@ Namespace OpenTK.Graphics.ES20.GL
 Change signature (may cause crash):
 - GL.NV.GetFence now takes three parameters instead of two
 
-Change “ref” parameters to “out”:
+Change `ref` parameters to `out`:
 - GL.GetActiveAttrib
 - GL.GetActiveUniform
 - GL.GetAttachedShaders

Documentation/Todo.txt

@@ -1,19 +1,13 @@
 [Easy]
 - Clean up warnings.
 - Remove Example Browser in favor of separate projects.
-- Add Nuget packages.
+- Speed up matrix Inverse() functions. (Patch exists in mono/opentk.)
-- Speed up matrix Inverse() functions. (Patch exists in mono/opentk).
 
 [Moderate]
-- Implement new joystick API.
 - Implement touch input API.
-- Fix external GraphicsContexts.
+- Implement force feedback API.
 - Add Portable Class Library (PCL) target.
-- Reduce library size for the PCL target. 
-- Split various APIs in different modules. This will be in addition to the monolithic OpenTK.dll.
 
 [Hard]
-- Remove DllImports/GetDelegateForFunctionPointer in favor of LCG calli instructions.
 - Merge updates from mono/opentk.
 - Add Cocoa backend for Mac OS X.
-- Add support for international text input.