Updated readme and added tutorial pdf.

AntMaster7 · Jan 13, 2019 · bdae86c · bdae86c
1 parent dfd69e5
commit bdae86c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,4 @@
 *.dll filter=lfs diff=lfs merge=lfs -text
 *.lib filter=lfs diff=lfs merge=lfs -text
+*.pptx filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
 # Box2D-Lite
-A small 2D physics engine. Developed to help people learn how game physics works.
+A small 2D physics engine. Developed for the [2006 GDC Physics Tutorial](docs/GDC2006_Catto_Erin_PhysicsTutorial.pdf).
+
+# Building
+- Install [CMake](https://cmake.org/)
+- Ensure CMake is in the user path
+- Visual Studio 2017: run build.bat
+- Otherwise: run build.sh from a bash shell
 
 # Build Status
-[![Build Status](https://travis-ci.org/erincatto/box2d-lite.svg?branch=master)](https://travis-ci.org/erincatto/box2d-lite)
+[![Build Status](https://travis-ci.org/erincatto/box2d-lite.svg?branch=master)](https://travis-ci.org/erincatto/box2d-lite)
diff --git a/build.bat b/build.bat
@@ -2,6 +2,6 @@ rem Use this batch file to build box2d-lite and samples for Visual Studio 2017
 rmdir /s /q build
 mkdir build
 cd build
-cmake .. -G "Visual Studio 15 2017" -A x64
+cmake ..
 cmake --build .
 start box2d-lite.sln
diff --git a/docs/GDC2006_Catto_Erin_PhysicsTutorial.pdf b/docs/GDC2006_Catto_Erin_PhysicsTutorial.pdf