utils-code/arzzen.git-quick-stats
1
0
Fork 0
mirror of https://github.com/arzzen/git-quick-stats.git synced 2026-09-10 15:46:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Lukas Mestan 2017-04-02 17:31:31 +02:00
parent d6c1d1e4fd
commit 3c3f261a7c
No known key found for this signature in database
GPG key ID: 93A4F5E8826DD56F
1 changed files with 67 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
README.md
View file

@ -1,18 +1,44 @@
## GIT quick statistics
[![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats)
[![homebrew](https://img.shields.io/homebrew/v/git-quick-stats.svg)]()
> `git quick-stats` is a simple and efficient way to access various statistics in git repository.
## Example
## Table of Contents
Suggested code reviewers (based on git history):
![screenshot from 2017-02-04 22-00-30](https://cloud.githubusercontent.com/assets/6382002/22621490/62257c30-eb25-11e6-8608-9cfe17509464.png)
[**Screenshots**](#screenshots)
Asciinema preview:
[![asciicast](https://asciinema.org/a/6fsugv3m2vygykk49bk7l49ut.png)](https://asciinema.org/a/6fsugv3m2vygykk49bk7l49ut)
[**Installation**](#installation)
* [**Unix OS**](#unix-like-os)
* [**OS X**](#os-x-homebrew)
* [**Windows**](#windows-cygwin)
[**Usage**](#usage)
* [**Git log since/unitl**](#git-log-since-until)
* [**Git log limit**](#git-log-limit)
* [**Git pathspec**](#git-pathspec)
* [**Tests**](#tests)
[**System requirements**](#system-requirements)
[**Contribution**](#contribution)
[**License**](#licensing)
Want to contribute? Great! First, [read this page][].
## Screenshots
![screenshot from 2017-04-02 17-10-21](https://cloud.githubusercontent.com/assets/6382002/24588459/bef0a1b8-17c8-11e7-8525-3ab5983b81dc.png)
![screenshot from 2017-04-02 17-09-13](https://cloud.githubusercontent.com/assets/6382002/24588456/bec1278a-17c8-11e7-8835-39273da7bc99.png)
![screenshot from 2017-04-02 17-09-31](https://cloud.githubusercontent.com/assets/6382002/24588457/beece9f6-17c8-11e7-80a4-274ecd314a7e.png)
![screenshot from 2017-04-02 17-09-45](https://cloud.githubusercontent.com/assets/6382002/24588458/bef03656-17c8-11e7-82e6-30a5a11cfbb0.png)
![screenshot from 2017-04-02 17-08-28](https://cloud.githubusercontent.com/assets/6382002/24588460/bef0c2e2-17c8-11e7-88b2-a4033593c5d0.png)
## Usage
@ -27,20 +53,19 @@ Or you can use (non-interactive) direct execution:
`git quick-stats <optional-command-to-execute-directly>`
> Possible arguments:
Possible arguments:
> suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors,
branchTree, branchesByDate, changelogs
branchTree, branchesByDate, changelogs, changelogsByAuthor
#### Git log --since and --until arguments
#### Git log since / until
You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
eg:
`export _GIT_SINCE="2017-20-01"`
`export _GIT_UNTIL="2017-22-01"`
```bash
export _GIT_SINCE="2017-20-01"
export _GIT_UNTIL="2017-22-01"
```
then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
@ -49,29 +74,45 @@ then run `git quick-stats` (affect all stats, except "My daily status" and "Git
You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
eg:
```bash
export _GIT_LIMIT=20
```
`export _GIT_LIMIT=20`
#### Git pathspec
You can exclude directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
```bash
export _GIT_PATHSPEC=':!directory'
```
## Installation
#### Unix like OS
```
```bash
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
sudo make install
```
For uninstalling, open up the cloned directory and run
```
```bash
sudo make uninstall
```
For update/reinstall
```bash
sudo make reinstall
```
#### OS X (homebrew)
`brew install git-quick-stats`
```bash
brew install git-quick-stats
```
#### Windows (cygwin)
@ -109,9 +150,16 @@ We use Github pull requests for this purpose.
This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
#### Tests
```bash
make test
```
## Licensing
MIT see [LICENSE][] for the full license text.
[read this page]: http://github.com/arzzen/git-quick-stats/blob/master/CONTRIBUTING.md
[landing page]: http://arzzen.github.io/git-quick-stats
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE.txt