doc/README

   1 gitstats is a statistics generator for git repositories.  It is mostly intended
   2 for developers, as a way to check some development statistics for a project.
   3
   4 Currently it produces only HTML output with tables and graphs.
   5
   6 Requirements
   7 ============
   8 - Python (>= 2.4.4)
   9 - Git (>= 1.5.2.4)
  10 - Gnuplot (>= 4.0.0)
  11 - Complete, clean git repository (bare or shallow will *not* do)
  12
  13 The above versions are not absolute requirements; older versions may work also.
  14
  15 Recommended
  16 ===========
  17 - Lots of memory and fast disk for large projects
  18
  19 Contributions
  20 =============
  21 Patches should be sent under "GPLv2 or older" license - this will allow
  22 upgrading to newer GPL versions if they are sensible.