Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
erincatto authored Jan 19, 2019
1 parent 509e929 commit 6879d1d
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
# Box2D-Lite
Box2D-Lite is a small 2D physics engine. It was developed for the [2006 GDC Physics Tutorial](docs/GDC2006_Catto_Erin_PhysicsTutorial.pdf). This is the original version of the larger [Box2D](https://box2d.org) library. The Lite version is more suitable for learning about game physics.

# Cloning
The Box2D-Lite sample program uses [GLFW](https://www.glfw.org/) and [dear imgui](https://github.com/ocornut/imgui) as git submodules. I recommend cloning Box2D-Lite using the following command:
```bash
git clone --recursive https://github.com/erincatto/box2d-lite.git
```

# 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
- Results are in the build sub-folder

# Build Status
[![Build Status](https://travis-ci.org/erincatto/box2d-lite.svg?branch=master)](https://travis-ci.org/erincatto/box2d-lite)

0 comments on commit 6879d1d

Please sign in to comment.