src/ppastats/ppastats.adoc

   1 = PPAstats
   2 :docinfo2:
   3 :icons: font
   4
   5 `ppastats` is a command line tool which produces HTML report for viewing
   6 download statistics of an Ubuntu PPA.
   7
   8 Examples are available at: http://wpitchoune.net/ppastats/files/examples.
   9
  10 The license of `ppastats` is GPL v2.
  11
  12 `ppastats` works fine with Firefox 6/7, Google Chrome 12 and IE8.
  13
  14 == Usage
  15
  16 ----
  17 ppastats jfi psensor-unstable -o /var/www/ppastats
  18 ----
  19
  20 Generates the HTML report for the PPA: `ppa:jfi/psensor-unstable`.
  21
  22 Use `ppastats --help` for more options.
  23
  24 == Installation
  25
  26 === Ubuntu
  27
  28 For Ubuntu, the easiest way to install `ppastats` is to use its
  29 dedicated PPA:
  30
  31 ----
  32 sudo apt-add-repository ppa:jfi/ppastats
  33 sudo apt-get update
  34 sudo apt-get install ppastats
  35 ----
  36
  37 === Compilation
  38
  39 `ppastats` should compile on any modern Linux distribution, it
  40 requires the `CURL` and `json-c` libraries.
  41
  42 Download the source archive from: http://wpitchoune.net/ppastats/files.
  43
  44 For compilation on Ubuntu:
  45
  46 ----
  47 apt-get install libcurl4-openssl-dev libjson0-dev
  48 ./configure
  49 make clean all
  50 ----
  51
  52 and finally, install `ppastats`:
  53
  54 ----
  55 sudo make install
  56 ----
  57
  58 Alternatively, the last development version can be retrieved using GIT:
  59
  60 ----
  61 git clone git://git.wpitchoune.net/ppastats.git
  62 ----
  63
  64 To build the Ubuntu package:
  65
  66 ----
  67 git clone git://git.wpitchoune.net/ppastats-pkg-ubuntu.git
  68 cd ppastats-pkg-ubuntu
  69 git-buildpackage
  70 ----
  71
  72 == Download
  73
  74 * link:files[Source archive]
  75
  76 == Contact
  77
  78 Bugs and comments can be sent to jeanfi@gmail.com.
  79
  80 For announces or general information subscribe to link:http://plus.google.com/u/0/115217597639251170338?prsrc=3[ppastats Google+ page].