hoxu
/
gitstats
mirror of https://github.com/hoxu/gitstats
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Browse Source

Updated some docs.

Heikki Hokkanen 17 years ago
parent
b75bf01262
commit
128e1adaae
2 changed files with 10 additions and 6 deletions
Unified View Show Diff Stats
  1. 7
    4
      doc/README
  2. 3
    2
      doc/author.txt

+ 7
- 4
doc/README View File

1 
-gitstats is a statistics generator for revision control systems (for now, only
2 
-git). It is mostly intended for developers, as a way to check some development
3 
-statistics for a project.
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.
4
3
5 
 Currently it produces only HTML output with tables and graphs.
 4 
 Currently it produces only HTML output with tables and graphs.
6
5
15
14
16 
 Recommended
 15 
 Recommended
17 
 ===========
 16 
 ===========
18 
-- Lot of memory and fast disk for large projects
17 
+- Lots of memory and fast disk for large projects
19
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.

+ 3
- 2
doc/author.txt View File

1 
 Author can be reached by sending e-mail to <hoxu@users.sf.net>.
 1 
 Author can be reached by sending e-mail to <hoxu@users.sf.net>.
2 
 Include "gitstats" in the subject or prepare to battle the spam filters.
 2 
 Include "gitstats" in the subject or prepare to battle the spam filters.
3
3
4 
+See the following command for list of authors who have contributed:
5 
+  $ git-shortlog HEAD
6 
+
4 
 Also thanks to the following people:
 7 
 Also thanks to the following people:
5 
 Alexander Botero-Lowry
 8 
 Alexander Botero-Lowry
6
9
7 
-See also:
8 
-  $ git-shortlog HEAD