Updated INSTALL file
authorSami Rämö <sami.ramo@ixonos.com>
Fri, 15 Oct 2010 08:05:01 +0000 (11:05 +0300)
committerSami Rämö <sami.ramo@ixonos.com>
Fri, 15 Oct 2010 08:05:01 +0000 (11:05 +0300)
INSTALL

diff --git a/INSTALL b/INSTALL
index 2ebf8bf..487dd40 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1 @@
-To install through make, type:
-
-make
-make install
-
-To create debian package, type:
-
-dpkg-buildpackage -rfakeroot -b -tc
+This is a rough instruction how to compile and test the\rapplication using Maemo 5 SKD. Some previous general knowledge\rof the Maemo 5 SDK / Scracthbox and installing packages is\rrequired since all the steps are not documented with enough details.\r\rAll the following commands are run in the Scratchbox, except\rthe ones related to installation to the device.\r\rPre-requirements\r----------------\r\r* Maemo 5 SDK - http://wiki.maemo.org/Documentation/Maemo_5_Final_SDK_Installation\r\rDependencies\r------------\r\r* Qt 4.6.2 - http://qt.nokia.com/\r\r    Qt is a cross-platform application and UI framework.\r    It includes a cross-platform class library, integrated\r    development tools and a cross-platform IDE. Using Qt,\r    you can write web-enabled applications once and deploy\r    them across many desktop and embedded operating systems\r    without rewriting the source code.\r\r    Install package libqt4-dev.\r\r* Qt Mobility - http://qt.nokia.com/products/appdev/add-on-products/catalog/4/new-qt-apis/mobility\r\r    Qt Mobility Project delivers a set of new APIs to Qt with\r    features that are well known from the mobile device world,\r    in particular phones. However, these APIs allow the\r    developer to use these features with ease from one framework\r    and apply them to phones, netbooks and non-mobile personal\r    computers. The framework not only improves many aspects of\r    a mobile experience, because it improves the use of these\r    technologies, but has applicability beyond the mobile device\r    arena.\r\r    Install package libqtm-dev.\r\r    NOTE: Qt Mobility is needed only for armel target.\r\r* QJson - http://qjson.sourceforge.net/\r  \r    QJson is a qt-based library that maps JSON data to\r    QVariant objects: JSON arrays will be mapped to\r    QVariantList instances, while JSON objects will be\r    mapped to QvariantMap.\r\r    Required files can be installed from extras repository\r    by installing package libqjson-dev.\r\rCompiling and running the application\r-------------------------------------\r\rMake sure the FREMANTLE_X86 target is currently selected.\rCompile the application and execute it by using the following\rcommands in the project root dir (assuming you have the Xephyr\rand Fremantle environment already running):\r\r  cd src  \r  qmake\r  make clean\r  make\r  run-standalone.sh ../situare\r\rCompiling for the actual device (Nokia N900)\r--------------------------------------------\r\rThis is a short list of phases required for running the\rapplication in the actual device. Many details are missing,\rso you must have some previous knowledge.\r\rUse FREMANTLE_ARMEL target when building for the device!\r\rThere are two different ways to achieve the result:\r\rA) Building deb package\r    - dpkg-buildpackage -rfakeroot -b -tc\r    - copy the resulted deb package to the device\r    - dpkg -i <package_name>\r    - if nags about dependencies, then:\r         apt-get install -f\r      (note: the extras repository must be enabled)\r    - run application from the applications menu\r\rB) Compiling and installing manually\r    - compile\r        cd src\r        qmake CONFIG+=armel\r        make clean\r        make\r    - copy the resulted binary "situare" (from the project\r      root directory) to the device\r    - install libqjson\r    - run the application from terminal\r\rCompiling and running the unit tests\r------------------------------------\r\rIn the project root dir:\r  cd tests\r  qmake\r  make clean\r  make\r  cd ../scripts\r  ./run_unit_tests.sh\r\rCompiling the application and unit tests\r----------------------------------------\r\rIn the project root dir:\r  qmake -r\r  make clean\r  make\r\rCompiling using Qt Nokia SDK\r----------------------------\r\r- use CONFIG+=armel parameter with qmake when building for\r  Maemo target\r- add QJson libraries to Fremantle sysroot\r     https://garage.maemo.org/plugins/wiki/index.php?How%20to%20add%20external%20libraries%20for%20Maemo%20target%20when%20compiling%20with%20Nokia%20Qt%20SDK&id=1420&type=g\r\r
\ No newline at end of file