Merge branch 'master' of git://labs.trolltech.com/qtscriptgenerator
[qtscriptgenerator/amarok.git] / README
blob7cb2e3fc07fbeec5aceb6b2f75876c326d083b60
1 Qt Script Generator labs package, version 0.1
4 The Qt Script Generator is a tool that generates Qt bindings for Qt Script.
6 ---
8 Instructions:
10 1) Build the generator: cd path/to/this/project/generator, qmake && make
12 2) Run the generator (without arguments)
13    This will generate C++ files in path/to/this/project/generated_cpp
14    and documentation in path/to/this/project/doc
16 3) Build the bindings plugins: cd path/to/this/project/qtbindings, qmake && make
17    The plugins will be put under path/to/this/project/plugins
19 4) To use the plugins in your application, add the plugins path to the library paths
20    (QCoreApplication::setLibraryPaths()), then call QScriptEngine::importExtension()
21    (plugin keys are "qt.core", "qt.gui", etc).
23 There is a simple script interpreter / launcher in path/to/this/project/qtbindings/qs_eval
24 that imports all the bindings. You can use it to run the examples found in
25 path/to/this/project/examples. E.g., with the examples directory being the working directory:
27 ../qtbindings/qs_eval/qs_eval CollidingMice.qs
30 See the generated doc/index.html for more information.
32 Have fun!