Skip to content

Commit 5b439a7

Browse files
committed
Update pom.xml and README.md
1 parent a4e2320 commit 5b439a7

File tree

2 files changed

+322
-279
lines changed

2 files changed

+322
-279
lines changed

README.md

Lines changed: 95 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,96 @@
1-
React
2-
=====
3-
Java port of the [ReactPhysics3D][ReactPhysics3D] C++ library by [Daniel Chappuis][OriginalAuthor], relicensed with permission.
1+
# Flow React [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)][License] [![Flattr this](http://img.shields.io/badge/flattr-donate-lightgrey.svg?style=flat)][Donate] [![Build Status](http://img.shields.io/travis/flow/react/develop.svg?style=flat)](https://travis-ci.org/flow/react) [![Coverage Status](http://img.shields.io/coveralls/flow/react/develop.svg?style=flat)](https://coveralls.io/r/flow/react)
42

5-
[ReactPhysics3D]: https://code.google.com/p/reactphysics3d/
6-
[OriginalAuthor]: http://www.danielchappuis.ch/
3+
Real-time 3D physics library for Java, based on the [ReactPhysics3D](https://code.google.com/p/reactphysics3d/) library by [Daniel Chappuis](http://www.danielchappuis.ch/).
4+
5+
## Features
6+
* Rigid body dynamics
7+
* Discrete collision detection
8+
* Collision shapes (Sphere, Box, Cone, Cylinder, Capsule, Convex Mesh)
9+
* Broadphase collision detection (Sweep and Prune using AABB)
10+
* Narrowphase collision detection (GJK/EPA)
11+
* Collision response and friction (Sequential Impulses solver)
12+
* Joints (Ball-and-socket, Hinge, Slider, Fixed)
13+
* Sleeping technique for inactive bodies
14+
* Multi-platform (Windows, Linux, Mac OS X)
15+
* Unit tests and Javadocs
16+
17+
## Getting Started
18+
* [Examples and code snippets](https://github.com/flow/examples/tree/master/react)
19+
* [Official documentation](#documentation)
20+
* [IRC support chat](http://kiwiirc.com/client/irc.esper.net/flow)
21+
* [Issues tracker](https://github.com/flow/react/issues)
22+
23+
## Source Code
24+
The latest and greatest source can be found here on [GitHub](https://github.com/flow/react). If you are using Git, use this command to clone the project:
25+
26+
git clone git://github.com/flow/react.git
27+
28+
Or download the latest [development archive](https://github.com/flow/react/archive/develop.zip) or the latest [stable archive](https://github.com/flow/react/archive/master.zip).
29+
30+
## Test Dependencies
31+
The following dependencies are only needed if you compiling the tests included with this project. Gotta test 'em all!
32+
* [junit:junit](https://oss.sonatype.org/#nexus-search;gav~junit~junit~~~)
33+
34+
## Building from Source
35+
This project can be built with the _latest_ [Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and [Maven](https://maven.apache.org/) or [Gradle](https://www.gradle.org/). Maven and Gradle are used to simplify dependency management, but using either of them is optional.
36+
37+
For Maven, the command `mvn clean package` will build the project and will put the compiled JAR in `target`, and `mvn clean install` will copy it to your local Maven repository.
38+
39+
For Gradle, the command `gradlew` will build the project and will put the compiled JAR in `~/build/distributions`, and `gradlew install` will copy it to your local Maven repository.
40+
41+
## Contributing
42+
Are you a talented programmer looking to contribute some code? We'd love the help!
43+
44+
* Open a pull request with your changes, following our [guidelines and coding standards](CONTRIBUTING.md).
45+
* Please follow the above guidelines for your pull request(s) accepted.
46+
* For help setting up the project, keep reading!
47+
48+
Love the project? Feel free to [donate] to help continue development! Flow projects are open-source and powered by community members, like yourself. Without you, we wouldn't be here today!
49+
50+
Don't forget to watch and star our repo to keep up-to-date with the latest Flow development!
51+
52+
## Usage
53+
If you're using [Maven](https://maven.apache.org/download.html) to manage project dependencies, simply include the following in your `pom.xml` file:
54+
55+
<dependency>
56+
<groupId>com.flowpowered</groupId>
57+
<artifactId>flow-react</artifactId>
58+
<version>1.0.0-SNAPSHOT</version>
59+
</dependency>
60+
61+
If you're using [Gradle](https://www.gradle.org/) to manage project dependencies, simply include the following in your `build.gradle` file:
62+
63+
repositories {
64+
mavenCentral()
65+
}
66+
dependencies {
67+
compile 'com.flowpowered:flow-react:1.0.0-SNAPSHOT'
68+
}
69+
70+
If you plan on using snapshots and do not already have the snapshot repo in your repository list, you will need to add this as well:
71+
72+
https://oss.sonatype.org/content/groups/public/
73+
74+
If you'd prefer to manually import the latest .jar file, you can get it [here](https://github.com/flow/react/releases).
75+
76+
## Documentation
77+
Want to get friendly with the project and put it to good use? Check out the latest [Javadocs](https://flowpowered.com/react).
78+
79+
To generate Javadocs with Maven, use the `mvn javadoc:javadoc` command. To view the Javadocs simply go to `target/site/apidocs/` and open `index.html` in a web browser.
80+
81+
To generate Javadocs with Gradle, use the `gradlew javadoc` command. To view the Javadocs simply go to `build/docs/javadoc/` and open `index.html` in a web browser.
82+
83+
## Version Control
84+
We've adopted the [git flow branching model](http://nvie.com/posts/a-successful-git-branching-model/) in our projects. The creators of git flow released a [short intro video](http://vimeo.com/16018419) to explain the model.
85+
86+
The `master` branch is production-ready and contains the latest tagged releases. Before a release is made, it is stagged in `release/x` branches before being pushed and tagged in the `master` branch. Small patches from `hotfix/x` branches are also pushed to `master`, and will always have a release version. The `develop` branch is pre-production, and is where we push `feature/x` branches for testing.
87+
88+
## Legal Stuff
89+
Flow React is licensed under the [MIT License][License]. Basically, you can do whatever you want as long as you include the original copyright. Please see the `LICENSE.txt` file for details.
90+
91+
## Credits
92+
* [Spout](https://spout.org/) and contributors - *where we all began, and for much of the re-licensed code.*
93+
* All the people behind [Java](http://www.oracle.com/technetwork/java/index.html), [Maven](https://maven.apache.org/), and [Gradle](https://www.gradle.org/).
94+
95+
[Donate]: https://flattr.com/submit/auto?user_id=spout&url=https://github.com/flow/react&title=Flow+React&language=Java&tags=github&category=software
96+
[License]: https://tldrlegal.com/l/mit

0 commit comments

Comments
 (0)