Add some basic docs

This commit is contained in:
R. Tyler Ballance 2009-01-02 14:13:35 -08:00
parent 9d451b5245
commit abe95d2854
2 changed files with 39 additions and 0 deletions

20
NOTES Normal file
View File

@ -0,0 +1,20 @@
_ _ ___ _____ _____ ____
| \ | | / _ \ |_ _| | ____| / ___|
| \| | | | | | | | | _| \___ \
| |\ | | |_| | | | | |___ ___) |
|_| \_| \___/ |_| |_____| |____/
=========================================
Things I want to add:
* Pre-generated sets of reports ready for cron
- Manager's Report
+ Run every week
+ Contains data from last 30 days
+ Set of authors, or default to "everybody"
+ Reports:
> Leaderboard
> Time of Day
> Commits/Churn ratio per-developer (not developed yet)
> Active modules, i.e. sub-directories (not developed yet)
> New files per-developer (not developed yet)

19
README Normal file
View File

@ -0,0 +1,19 @@
____ _____ _ ____ __ __ _____
| _ \ | ____| / \ | _ \ | \/ | | ____|
| |_) | | _| / _ \ | | | | | |\/| | | _|
| _ < | |___ / ___ \ | |_| | | | | | | |___
|_| \_\ |_____| /_/ \_\ |____/ |_| |_| |_____|
===================================================
ABOUT
-----------------
git-plot is a tool intended on helping visualize activity being performed inside a
particular Git repository.
Currently the project is not "released" insofar that it's really far more experimental
than anything else right now.
REQUIREMENTS
-----------------
git-plot depends on Python, Cairo and PyCairo being installed; and naturally Git