From 11f194ac73004788b8453196ea79e0be6cee4ced Mon Sep 17 00:00:00 2001 From: the_fiddler Date: Tue, 25 Aug 2009 14:46:01 +0000 Subject: [PATCH] Simplified build and usage instructions. Moved Instructions.txt to documentation folder. --- Build/Instructions.txt | 38 ---------------------------------- Documentation/Instructions.txt | 21 +++++++++++++++++++ 2 files changed, 21 insertions(+), 38 deletions(-) delete mode 100644 Build/Instructions.txt create mode 100644 Documentation/Instructions.txt diff --git a/Build/Instructions.txt b/Build/Instructions.txt deleted file mode 100644 index 6664745c..00000000 --- a/Build/Instructions.txt +++ /dev/null @@ -1,38 +0,0 @@ -Installation - -OpenTK does not require installation. Simply decompress the archive to a folder of your choice. - - -Usage - -To use OpenTK, you need to reference "OpenTK.dll". Refer to http://www.opentk.com/doc for specific instructions. - -Regardless of your development environment and operating system, ensure that you copy "OpenTK.dll.config" to the output directory. Without OpenTK.dll.config, your application will not function on Linux or MacOS. - - -Build instructions - -You can build OpenTK using Visual Studio 2005+, SharpDevelop 2.0+, MonoDevelop 2.0+, msbuild or nant. Instructions: - -1a. Open the Build/ folder. - -1b. If you are using a fresh SVN checkout, double click "Build.exe", type "vs" and press enter twice to create OpenTK.sln. This step is not necessary if you are using a released version of OpenTK. - -2a. If you are using Visual Studio, SharpDevelop or MonoDevelop, double-click OpenTK.sln, select a build configuration (debug/release) and build the project. - -2b. If you wish to build from the commandline: - -[Windows] -Make sure msbuild is in your path and type: - -cd Build -Build.exe vs -msbuild - -[Linux / MacOS] -Make sure nant (http://nant.sourceforge.net) is in your path and type: - -cd Build/ -mono Build.exe nant release - -4. The resulting binaries are placed into the Binaries/Release or Binaries/Debug folder. \ No newline at end of file diff --git a/Documentation/Instructions.txt b/Documentation/Instructions.txt new file mode 100644 index 00000000..faa4fe18 --- /dev/null +++ b/Documentation/Instructions.txt @@ -0,0 +1,21 @@ +=== Installation === + +OpenTK does not require installation. Simply decompress the archive to a folder of your choice. + + +=== Usage === + +To use OpenTK, simply add "OpenTK.dll" as a reference to your project. You can find this file under "Binaries/OpenTK". + +Additionally, you should add "OpenTK.dll.config" to your project and set it to be copied to your output directory. Without OpenTK.dll.config, your application will not function correctly on Linux or MacOS. + +For more details, refer to "http://www.opentk.com/doc". + + +=== Build instructions === + +If you are using a fresh SVN checkout execute Build.exe to generate OpenTK.sln (simply press enter when prompted). + +You can build OpenTK.sln using Visual Studio 2005+, SharpDevelop 2.0+, MonoDevelop 2.0+. Additionally, you can use msbuild 9+ (.Net) or xbuild 2.4.2 (Mono) to build OpenTK.sln from the commandline. + +The resulting binaries will be placed into the Binaries/OpenTK/[Release|Debug] folders. \ No newline at end of file