Skip to content

Commit

Permalink
Copy Readme.md to root directory.
Browse files Browse the repository at this point in the history
This file is displayed on the github splash screen.
  • Loading branch information
jsanmiya committed Jul 16, 2014
1 parent 927e9d8 commit 6e9abe4
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,44 @@
LiquidFun Version [1.0.0][]
<img src="../../Programmers-Guide/html/liquidfun-logo-square-small.png"
alt="LiquidFun logo" style="float:right;" />

LiquidFun Version [1.1.0][]

# Welcome to LiquidFun!

LiquidFun is a 2D physics engine for games. Go to our
[landing page][] to browse our documentation and see some examples.

LiquidFun is an extension of [Box2D][], it adds a particle based fluid and soft
body simulation to the rigid body functionality in [Box2D][]. LiquidFun can be
built for many different systems (Android, Windows, OS X, Linux), see
`Box2D/Documentation/Building/`
LiquidFun is an extension of [Box2D][]. It adds a particle based fluid and soft
body simulation to the rigid body functionality of [Box2D][]. LiquidFun can be
built for many different systems, including Android, iOS, Windows, OS X, Linux,
and JavaScript. Please see `Box2D/Documentation/Building/` for details.

Discuss LiquidFun with other developers and users on the
[LiquidFun Google Group][]. File issues on the [LiquidFun Issues Tracker][]
[LiquidFun Google Group][]. File issues on the [LiquidFun Issues Tracker][]
or post your questions to [stackoverflow.com][] with a mention of
**liquidfun**.

Please see `Box2D/Documentation/Building/` to learn how to build LiquidFun and
Please see [Box2D/Documentation/Building/][] to learn how to build LiquidFun and
run the testbed.

LiquidFun has a logo that you can use, in your splash screens or documentation,
for example. Please see the [Programmer's Guide][] for the graphics and further
details.

For applications on Google Play that integrate this tool, usage is tracked.
This tracking is done automatically using the embedded version string
(b2_liquidFunVersionString), and helps us continue to optimize it. Aside from
consuming a few extra bytes in your application binary, it shouldn't affect
your application at all. We use this information to let us know if LiquidFun
is useful and if we should continue to invest in it. Since this is open
your application at all. We use this information to let us know if LiquidFun
is useful and if we should continue to invest in it. Since this is open
source, you are free to remove the version string but we would appreciate if
you would leave it in.

[LiquidFun Google Group]: http://group.google.com/group/liquidfun
[LiquidFun Issues Tracker]: http://github.com/google/liquidfun/issues
[stackoverflow.com]: http://www.stackoverflow.com
[landing page]: http://google.github.io/liquidfun
[1.0.0]: http://google.github.io/liquidfun/ReleaseNotes.html
[1.1.0]: http://google.github.io/liquidfun/ReleaseNotes.html
[Box2D]: http://box2d.org
[Box2D/Documentation/Building/]: ../../Building/html/index.html
[Programmer's Guide]: ../../Programmers-Guide/html/md__logo.html

0 comments on commit 6e9abe4

Please sign in to comment.