Made joints easier to create
[qml-box2d:anubhavtiwaris-qml-box2d.git] / README
1 QML Box2D plugin
2 ----------------
3
4 This plugin is meant to be installed to your Qt/imports directory, or shipped
5 in a directory of which the parent is added as import path.
6
7 The goal is to expose the functionality of Box2D as QML components, in order
8 to make it easy to write physics based games in QML.
9
10
11 INSTALLING
12
13  qmake
14  make
15  make install  (goes to Qt's import path, run with sudo if necessary)
16
17
18 RUNNING THE EXAMPLE
19
20  qmlviewer examples/boxes/boxes.qml
21
22
23 DEPLOYMENT
24
25 Support for deployment to mobile devices like the N900 and N8 is being worked
26 on.
27
28
29 USING QT CREATOR
30
31 For running you can use a "Custom Executable" configuration set to run
32 "qmlviewer" with the right parameters.
33
34 When you have write permissions to Qt's import path, it can be convenient to
35 add a deployment step to your run settings:
36
37  * Go to Projects -> box2d -> Run Settings
38  * Choose Add Deploy Step -> Make
39  * Enter "install" under "Make arguments"
40
41 This will make sure that before running, the version of the plugin is updated
42 in Qt's import path.