From 77519f7da0ede9aba59a59b5aa481c8c19ed828a Mon Sep 17 00:00:00 2001 From: Daniel Chappuis Date: Mon, 16 Feb 2015 22:36:45 +0100 Subject: [PATCH] Update Readme file --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ README.txt | 20 -------------------- 2 files changed, 38 insertions(+), 20 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 00000000..d745e025 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +## ReactPhysics3D + +ReactPhysics3D is an open source C++ physics engine library that can be used in 3D simulations and games. + +Website : [http://www.reactphysics3d.com](http://www.reactphysics3d.com) + +## Features + +ReactPhysics3D has the following features : + +- Rigid body dynamics +- Discrete collision detection +- Collision shapes (Sphere, Box, Cone, Cylinder, Capsule, Convex Mesh) +- Multiple collision shapes per body +- Broadphase collision detection (Dynamic AABB tree) +- Narrowphase collision detection (GJK/EPA) +- Collision response and friction (Sequential Impulses Solver) +- Joints (Ball and Socket, Hinge, Slider, Fixed) +- Collision filtering with categories +- Ray casting +- Sleeping technique for inactive bodies +- Integrated Profiler +- Multi-platform (Windows, Linux, Mac OS X) +- Documentation (User manual and Doxygen API) +- Examples +- Unit tests + +## License + +The ReactPhysics3D library is released under the open-source [ZLib license](http://opensource.org/licenses/zlib). + +## Documentation + +You can find the User Manual and the Doxygen API Documentation [here](http://www.reactphysics3d.com/documentation.html) + +## Issues + +If you find any issue with the library, you can report it on the issue tracker [here](https://github.com/DanielChappuis/reactphysics3d/issues). diff --git a/README.txt b/README.txt deleted file mode 100644 index 321c5881..00000000 --- a/README.txt +++ /dev/null @@ -1,20 +0,0 @@ -ReactPhysics3D is an open source C++ physics engine library that can be used in 3D simulations and games. The library is released under the ZLib license. - -ReactPhysics3D has the following features : - -- Rigid body dynamics -- Discrete collision detection -- Collision shapes (Sphere, Box, Cone, Cylinder, Capsule, Convex Mesh) -- Broadphase collision detection (Sweep and Prune using AABBs) -- Narrowphase collision detection (GJK/EPA) -- Collision response and friction (Sequential Impulses Solver) -- Joints (Ball and Socket, Hinge, Slider, Fixed) -- Sleeping technique for inactive bodies -- Integrated Profiler -- Multi-platform (Windows, Linux, Mac OS X) -- Documentation (User manual and Doxygen API) -- Examples -- Unit tests - -Website : https://code.google.com/p/reactphysics3d/ -Author : Daniel Chappuis