← Back to branch summary

~cjwatson/libusermetrics/valgrind-optional

« back to all changes in this revision

Viewing changes to doc/mainpage.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:
doc/mainpage.md
 
1
Welcome to Libusermetrics {#mainpage}
 
2
==============
 
3
 
 
4
Libusermetrics is a set of libraries
 
5
and a storage service designed to collect aggregated numerical data about
 
6
users. 
 
7
 
 
8
Getting and installing libusermetrics
 
9
-------------------------------------
 
10
 
 
11
### Using pre-built packages
 
12
 
 
13
If you just want to try out libusermetrics, or write user metrics sources,
 
14
then the easiest way is to use the pre-built packages:
 
15
 
 
16
 - \ref installing_prebuilt
 
17
 
 
18
### Building and installing from source
 
19
 
 
20
If you are curious about libusermetrics's internals or intend to contribute to
 
21
it, you should get the source and build it:
 
22
 
 
23
 - \ref building_source
 
24
 
 
25
Getting involved
 
26
----------------
 
27
 
 
28
The best place to ask questions and discuss about libusermetrics is the \#ubuntu-touch
 
29
IRC channel on freenode. 
 
30
 
 
31
The libusermetrics project is hosted on Launchpad: https://launchpad.net/libusermetrics
 
32
 
 
33
Please file bug reports at: http://bugs.launchpad.net/libusermetrics
 
34
 
 
35
Writing metric data sources
 
36
---------------------------
 
37
 
 
38
 - \ref UserMetricsInput "Libusermetrics Input API Documentation"
 
39
 
 
40
 For simple metrics which only want to increment a counter, see the following examples:
 
41
 
 
42
 - \subpage MetricManagerToday.cpp "MetricManagerToday.cpp: A simple Qt-based metric"
 
43
 - \subpage MetricManagerTodayCAPI.c "MetricManagerTodayCAPI.c: A simple C-based metric"
 
44
 
 
45
For more sophisticated metrics, which wish to update the history of the metric, for
 
46
example if the user has been offline for a week. Please see the following examples:
 
47
 
 
48
 - \subpage MetricManagerToday.cpp "MetricManagerAdvanced.cpp: A Qt-based metric"
 
49
 - \subpage MetricManagerTodayCAPI.c "MetricManagerAdvancedCAPI.c: A C-based metric"
 
50
 
 
51
Writing a presentation application
 
52
----------------------------------
 
53
 
 
54
To write a metric presentation application, there is a Qt API.
 
55
 
 
56
 - \ref UserMetricsOutput "Libusermetrics Output API Documentation"
 
57
 - A good example to refer to is the
 
58
   [infographics](https://bazaar.launchpad.net/~unity-team/unity8/trunk/view/head:/Greeter/Infographics.qml)
 
59
   for the Unity8 greeter.