Merge lp:~gang65/messaging-app/messaging-app-readme into lp:messaging-app

Proposed by Bartosz Kosiorek
Status: Needs review
Proposed branch: lp:~gang65/messaging-app/messaging-app-readme
Merge into: lp:messaging-app
Diff against target: 92 lines (+88/-0)
1 file modified
README.Developers.md (+88/-0)
To merge this branch: bzr merge lp:~gang65/messaging-app/messaging-app-readme
Reviewer Review Type Date Requested Status
PS Jenkins bot continuous-integration Needs Fixing
Ubuntu Phablet Team Pending
Review via email: mp+284507@code.launchpad.net

Commit message

Add README file to messaging application

Description of the change

Add README file to messaging application

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)

Unmerged revisions

486. By Bartosz Kosiorek

Add README file to messaging application

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added file 'README.Developers.md'
2--- README.Developers.md 1970-01-01 00:00:00 +0000
3+++ README.Developers.md 2016-01-30 00:25:18 +0000
4@@ -0,0 +1,88 @@
5+Building and running on Vivid Desktop (15.04)
6+=============================================
7+
8+**DEPENDENCIES ARE NEEDED TO BE INSTALLED TO BUILD AND RUN THE APP**.
9+
10+Most of packages could be installed by following comand:
11+
12+ $ sudo apt-get build-dep messaging-app
13+ $ sudo apt-get build-dep telephony-service
14+
15+A complete list of dependencies for the project can be found in messaging-app/debian/control
16+
17+Building and running the Messaging App will require
18+Ubuntu 15.04 and higher to run on the desktop.
19+
20+Before building message you need to build and install telephony-service
21+
22+ $ bzr branch lp:telephony-service
23+ $ mkdir builddir && cd builddir
24+ $ cmake -DCMAKE_INSTALL_PREFIX=/usr ../ && cmake --build . -- -j 3
25+ $ sudo make install
26+
27+Now build and install messaging-app with commands:
28+
29+ $ bzr branch lp:messaging-app branch-name
30+ $ cd branch-name
31+ $ mkdir builddir && cd builddir
32+ $ cmake -DCMAKE_INSTALL_PREFIX=/usr ../ && cmake --build . -- -j 3
33+
34+To run application type:
35+ ./src/messaging-app
36+
37+To install messaging application you could run command
38+ $ sudo make install
39+
40+
41+Submitting a patch upstream
42+===========================
43+
44+If you want to submit a bug fix you can do so by branching the code as shown
45+above, implementing the fixes and running to see if it fixed the issue. We also
46+request that you run the Autopilot and Unit tests to check if anything
47+regressed due to the bug fix.
48+
49+If the tests fail, you will have to fix them before your bug fix can be
50+approved and merged into trunk. If the tests pass then commit and push your
51+code by,
52+
53+ $ bzr commit -m "Implemented bug fix" --fixes lp:bug-number
54+ $ bzr push lp:~launchpadid/messaging-app/branch-name
55+
56+
57+Running Tests
58+=============
59+
60+* If you want to run all tests, then after building run the following command:
61+
62+ $ ctest --output-on-failure
63+
64+
65+Debugging
66+=========
67+
68+GDB allows one to see what is going on `inside' another program while it executes,
69+or what another program was doing at the moment it crashed. It is a pretty niffty tool which allows you
70+to get the crash log that can help a developer pin point the cause of the crash.
71+Before reproducing crash it is good to create symbols table for gdb, by using command:
72+
73+ $ cd branch-name
74+ $ mkdir builddir && cd builddir
75+ $ cmake -DCMAKE_BUILD_TYPE=Debug .. && cmake --build . -- -j 3
76+
77+To run GDB:
78+
79+ $ gdb src/messaging-app
80+
81+At this point, you are inside the gdb prompt. Run your application as you normally would.
82+
83+ run
84+
85+Your app is now running and monitored by GDB. Reproduce the steps in your app to make it crash. Once it does crash,
86+
87+ bt
88+
89+That's about it. To quit GDB, type quit to return back to the normal terminal console.
90+
91+ quit
92+

Subscribers

People subscribed via source and target branches