~cjwatson/libusermetrics/valgrind-optional

« back to all changes in this revision

Viewing changes to doc/building_source.md

  • Committer: Pete Woods
  • Date: 2013-07-09 16:51:58 UTC
  • mto: This revision was merged to the branch mainline in revision 100.
  • Revision ID: pete.woods@canonical.com-20130709165158-rcym0f05hz714k29
Documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Building the source {#building_source}
 
2
======================================
 
3
 
 
4
Getting libusermetrics
 
5
----------------------
 
6
 
 
7
Libusermetrics is a project on Launchpad (https://launchpad.net/libusermetrics).
 
8
To grab a copy use the command:
 
9
 
 
10
    $ bzr branch lp:libusermetrics
 
11
 
 
12
 
 
13
Getting dependencies
 
14
--------------------
 
15
 
 
16
To succesfully build libusermetrics there are a few packages required. The
 
17
easiest way to get them is to use the packaging build dependencies:
 
18
 
 
19
    $ sudo apt-get install devscripts equivs cmake
 
20
    $ sudo mk-build-deps --install --tool "apt-get -y" --build-dep debian/control
 
21
 
 
22
 
 
23
Building libusermetrics
 
24
-----------------------
 
25
 
 
26
Libusermetrics is built using cmake. To make life simpler, you can use the
 
27
included wrapper script:
 
28
 
 
29
    $ ./build
 
30
    
 
31
This will run cmake in the directory
 
32
 
 
33
    ../${BRANCH_NAME}-build
 
34
 
 
35
You can also ask it to create an Eclipse project as follows:
 
36
 
 
37
    $ ./build -e
 
38
 
 
39
The next step is to build the source and run the tests:
 
40
 
 
41
    $ cd ../libusermetrics-build/make (-j8)
 
42
    $ make check
 
43
 
 
44
Installing libusermetrics
 
45
-------------------------
 
46
 
 
47
To install libusermetrics just use the normal make install command:
 
48
 
 
49
    $ make install
 
50
 
 
51
This will install the libusermetrics input / output libraries, storage service,
 
52
and header files to the configured installation location (/usr/local by
 
53
default). If you install to a non-standard location, keep in mind that you will
 
54
probably need to properly set the PKG_CONFIG_PATH environment variable to allow
 
55
other applications to build against libusermetrics, and LD_LIBRARY_PATH to allow
 
56
applications to find the libusermetrics libraries at runtime.