Skip to content

Commit 5d19eea

Browse files
committed
Merge branch 'master' of git://github.com/dknacht/Box2D into dknacht-master
1 parent 71f5129 commit 5d19eea

File tree

7 files changed

+47
-36
lines changed

7 files changed

+47
-36
lines changed

Box2D/Building.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Building Box2D
2+
3+
The Box2D library is easy to build. I recommend adding the source files in the Box2D folder into your build system or project files for your IDE. The Box2D library is portable, so you should not need to configure it for your platform.
4+
5+
Building the testbed is optional and may not work on your platform. I use [premake5](https://premake.github.io/) to generate projects for the testbed. You can get premake5 here: https://premake.github.io/.
6+
7+
I support premake working well for [Visual Studio](https://www.visualstudio.com) on Windows 10 and [Xcode](https://developer.apple.com/xcode/) on MacOS. I appreciate contributions to get premake working on other platforms.
8+
9+
### Visual Studio
10+
Here are the steps for Visual Studio 2017:
11+
- Command line: `premake5 vs2017`
12+
- Open the resulting `Box2D.sln` (should be in `Build/vs2017`)
13+
- Set Testbed as the startup project
14+
- In the Testbed debugging properties, set the Working Directory to `..\Testbed`
15+
- Press <kbd>F5</kbd> to build and run the Testbed
16+
17+
### Xcode
18+
Here are the steps for Xcode:
19+
- Command line: `premake5 xcode4`
20+
- Open the resulting project file (should be `Build/xcode4`)
21+
- Set the Testbed as the current Scheme
22+
- Edit the Testbed Scheme, in the Run Options, use a custom working directory
23+
- Set the Testbed directory as the working directory
24+
- Press <kbd>Command</kbd>-<kbd>R</kbd> to build and run the Testbed
25+
26+
Thanks,
27+
Erin

Box2D/Building.txt

Lines changed: 0 additions & 23 deletions
This file was deleted.

Box2D/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Version 2.3.0
2+
- Polygon creation now computes the convex hull. Vertices no longer need to be ordered.
3+
- The convex hull code will merge vertices closer than dm_linearSlop. This may lead to failure on very small polygons.
4+
- Added b2MotorJoint.
5+
- Bug fixes.

Box2D/Changes.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

Contributions/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
![Box2D Logo](http://box2d.org/images/icon.gif)
2+
3+
# Box2D Contributions
4+
5+
This folder contains user contributions.
6+
7+
Contributions are **not** supported by the Box2D project. Contributions *may not* compile or function correctly.

Contributions/Readme.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
For help with Box2D, please visit http://www.box2d.org. There is a forum there where you may post your questions.
88

9-
Please see `Building.txt` to learn how to build Box2D and run the testbed.
9+
Please see [Building.md](https://github.com/erincatto/Box2D/blob/master/Box2D/Building.md) to learn how to build Box2D and run the testbed.
1010

1111
## Demos
1212

@@ -59,10 +59,13 @@ Please do not submit pull requests with new features. Instead, please file an is
5959
- Mouse picking and the bomb!
6060
- CMake build system files
6161

62-
### Documentation
63-
- User manual
64-
- Doxygen document with code comments
65-
- Active user forum
62+
## Documentation
63+
You can find documentation related to the project in the [documentation page](http://box2d.org/documentation/) and in the [documentation folder](https://github.com/erincatto/Box2D/tree/master/Box2D/Documentation) in GitHub
64+
- [User manual](http://box2d.org/manual.pdf)
65+
- [Doxygen document](https://github.com/erincatto/Box2D/blob/master/Box2D/Documentation/Doxyfile) with code comments
66+
- [Active user forum](http://box2d.org/forum/)
67+
68+
You can also visit the project wiki where you will find the [FAQ](https://github.com/erincatto/Box2D/wiki/FAQ)'s page
6669

6770
## License
6871

0 commit comments

Comments
 (0)