Browse Source

Updated readme.

bkaradzic 13 years ago
parent
commit
bc23e21067
1 changed files with 46 additions and 14 deletions
  1. 46 14
      README.md

+ 46 - 14
README.md

@@ -30,14 +30,46 @@ Optional:
 Building
 --------
 
-Getting source:
+### Prerequsites
+
+Premake 4.4 beta4
+[http://industriousone.com/premake/download](http://industriousone.com/premake/download)
+
+GNU make. Windows users download GNU make utility from:
+[http://gnuwin32.sourceforge.net/packages/make.htm](http://gnuwin32.sourceforge.net/packages/make.htm)
+
+### Getting source
 
 	git clone git://github.com/bkaradzic/bx.git
 	git clone git://github.com/bkaradzic/bgfx.git
 	cd bgfx
 	make
 
-After calling make, .build/projects/* directory will be generated. All intermediate files generated by compiler will be inside .build directory structure. Deleting .build directory at any time is safe.
+After calling make, .build/projects/* directory will be generated. All
+intermediate files generated by compiler will be inside .build directory
+structure. Deleting .build directory at any time is safe.
+
+### Building for Windows
+
+When building on Windows, you have to set DXSDK_DIR environment variable to
+point to DirectX SDK directory.
+
+	setx DXSDK_DIR <path to DirectX SDK directory>
+
+If you're building with MinGW/TDM compiler on Windows make DirectX SDK
+directory link to directory without spaces in the path.
+
+	mklink /D <path to DirectX SDK directory> c:\dxsdk
+	setx DXSDK_DIR c:\dxsdk
+
+### Building for Native Client (Pepper 22) on Windows
+
+Download Native Client SDK from
+[https://developers.google.com/native-client/sdk/download](https://developers.google.com/native-client/sdk/download)
+
+	setx NACL_DIR <path to Native Client SDK directory>
+
+### Building
 
 Visual Studio 2008:
 
@@ -99,11 +131,11 @@ License
 
 Copyright 2010-2012 Branimir Karadzic. All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-   1. Redistributions of source code must retain the above copyright notice, this
-      list of conditions and the following disclaimer.
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
 
    2. Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
@@ -111,11 +143,11 @@ are permitted provided that the following conditions are met:
 
 THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
-SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-OF THE POSSIBILITY OF SUCH DAMAGE.
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.