<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.20" xml:lang="en-US">
  <compounddef id="mainpage_8md" kind="file" language="Markdown">
    <compoundname>mainpage.md</compoundname>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline><highlight class="normal">#<sp/>Welcome<sp/>to<sp/>Libusermetrics</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">Libusermetrics<sp/>enables<sp/>apps<sp/>to<sp/>locally<sp/>store<sp/>interesting<sp/>numerical<sp/>data</highlight></codeline>
<codeline><highlight class="normal">for<sp/>later<sp/>presentation.<sp/><sp/>For<sp/>example<sp/>in<sp/>the<sp/>Ubuntu<sp/>Greeter<sp/>&quot;flower&quot;</highlight></codeline>
<codeline><highlight class="normal">infographic.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>All<sp/>data<sp/>is<sp/>stored<sp/>locally<sp/>in<sp/>/var/usermetrics/.</highlight></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>No<sp/>data<sp/>is<sp/>centrally<sp/>collected<sp/>via<sp/>a<sp/>web-serivice<sp/>or<sp/>otherwise,<sp/>and</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/>no<sp/>data<sp/>is<sp/>sent<sp/>over<sp/>the<sp/>internet.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">The<sp/>only<sp/>data<sp/>that<sp/>can<sp/>be<sp/>stored<sp/>is<sp/>numerical,<sp/>for<sp/>example<sp/>&quot;number<sp/>of</highlight></codeline>
<codeline><highlight class="normal">e-mails&quot;<sp/>or<sp/>&quot;number<sp/>of<sp/>pictures<sp/>taken&quot;.<sp/>No<sp/>personally<sp/>identifying</highlight></codeline>
<codeline><highlight class="normal">information<sp/>is<sp/>stored<sp/>using<sp/>this<sp/>library.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">**WARNING:**<sp/>This<sp/>API<sp/>should<sp/>be<sp/>considered<sp/>private,<sp/>and<sp/>is<sp/>only<sp/>for<sp/>use<sp/>by</highlight></codeline>
<codeline><highlight class="normal">first<sp/>party<sp/>applications<sp/>at<sp/>present.<sp/>It<sp/>may<sp/>change<sp/>or<sp/>be<sp/>removed<sp/>at<sp/>any</highlight></codeline>
<codeline><highlight class="normal">time.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">##<sp/>Getting<sp/>and<sp/>installing<sp/>libusermetrics</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">###<sp/>Using<sp/>pre-built<sp/>packages</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">If<sp/>you<sp/>just<sp/>want<sp/>to<sp/>try<sp/>out<sp/>libusermetrics,<sp/>or<sp/>write<sp/>user<sp/>metrics<sp/>sources,</highlight></codeline>
<codeline><highlight class="normal">then<sp/>the<sp/>easiest<sp/>way<sp/>is<sp/>to<sp/>use<sp/>the<sp/>[pre-built<sp/>packages](doc/pages/installing_prebuilt.md).</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">###<sp/>Building<sp/>and<sp/>installing<sp/>from<sp/>source</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">If<sp/>you<sp/>are<sp/>curious<sp/>about<sp/>libusermetrics&apos;s<sp/>internals<sp/>or<sp/>intend<sp/>to<sp/>contribute<sp/>to</highlight></codeline>
<codeline><highlight class="normal">it,<sp/>you<sp/>should<sp/>[get<sp/>the<sp/>source<sp/>and<sp/>build<sp/>it](doc/pages/building_source.md).</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">Getting<sp/>involved</highlight></codeline>
<codeline><highlight class="normal">----------------</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">The<sp/>best<sp/>place<sp/>to<sp/>ask<sp/>questions<sp/>and<sp/>discuss<sp/>about<sp/>libusermetrics<sp/>is<sp/>the<sp/>\#ubuntu-touch</highlight></codeline>
<codeline><highlight class="normal">IRC<sp/>channel<sp/>on<sp/>freenode.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">The<sp/>libusermetrics<sp/>project<sp/>is<sp/>hosted<sp/>on<sp/>Launchpad:<sp/>https://launchpad.net/libusermetrics</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">Please<sp/>file<sp/>bug<sp/>reports<sp/>at:<sp/>http://bugs.launchpad.net/libusermetrics</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">Writing<sp/>metric<sp/>data<sp/>sources</highlight></codeline>
<codeline><highlight class="normal">---------------------------</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\ref<sp/>UserMetricsInput<sp/>&quot;Libusermetrics<sp/>Input<sp/>API<sp/>Documentation&quot;</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">For<sp/>simple<sp/>metrics<sp/>which<sp/>only<sp/>want<sp/>to<sp/>increment<sp/>a<sp/>counter,<sp/>see<sp/>the<sp/>following<sp/>examples:</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerIncrementToday.cpp<sp/>&quot;MetricManagerIncrementToday.cpp:<sp/>A<sp/>simple<sp/>Qt-based<sp/>metric&quot;</highlight></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerIncrementTodayCAPI.c<sp/>&quot;MetricManagerIncrementTodayCAPI.c:<sp/>A<sp/>simple<sp/>C-based<sp/>metric&quot;</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">For<sp/>simple<sp/>metrics<sp/>which<sp/>only<sp/>want<sp/>to<sp/>update<sp/>today&apos;s<sp/>value,<sp/>but<sp/>cannot<sp/>simply<sp/>increment<sp/>it,</highlight></codeline>
<codeline><highlight class="normal">see<sp/>the<sp/>following<sp/>examples:</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerUpdateToday.cpp<sp/>&quot;MetricManagerUpdateToday.cpp:<sp/>A<sp/>simple<sp/>Qt-based<sp/>metric&quot;</highlight></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerUpdateTodayCAPI.c<sp/>&quot;MetricManagerUpdateTodayCAPI.c:<sp/>A<sp/>simple<sp/>C-based<sp/>metric&quot;</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">For<sp/>more<sp/>sophisticated<sp/>metrics,<sp/>which<sp/>wish<sp/>to<sp/>update<sp/>the<sp/>history<sp/>of<sp/>the<sp/>metric,<sp/>for</highlight></codeline>
<codeline><highlight class="normal">example<sp/>if<sp/>the<sp/>user<sp/>has<sp/>been<sp/>offline<sp/>for<sp/>a<sp/>week.<sp/>Please<sp/>see<sp/>the<sp/>following<sp/>examples:</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerAdvanced.cpp<sp/>&quot;MetricManagerAdvanced.cpp:<sp/>A<sp/>Qt-based<sp/>metric&quot;</highlight></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\subpage<sp/>MetricManagerAdvancedCAPI.c<sp/>&quot;MetricManagerAdvancedCAPI.c:<sp/>A<sp/>C-based<sp/>metric&quot;</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">Writing<sp/>a<sp/>presentation<sp/>application</highlight></codeline>
<codeline><highlight class="normal">----------------------------------</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">To<sp/>write<sp/>a<sp/>metric<sp/>presentation<sp/>application,<sp/>there<sp/>is<sp/>a<sp/>Qt<sp/>API.</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>\ref<sp/>UserMetricsOutput<sp/>&quot;Libusermetrics<sp/>Output<sp/>API<sp/>Documentation&quot;</highlight></codeline>
<codeline><highlight class="normal"><sp/>-<sp/>A<sp/>good<sp/>example<sp/>to<sp/>refer<sp/>to<sp/>is<sp/>the</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/>[infographics](https://bazaar.launchpad.net/~unity-team/unity8/trunk/view/head:/Greeter/Infographics.qml)</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/>for<sp/>the<sp/>Unity8<sp/>greeter.</highlight></codeline>
    </programlisting>
    <location file="/home/odroid/lomiri/libusermetrics-git/src/libusermetrics/doc/pages/mainpage.md"/>
  </compounddef>
</doxygen>
