Mirror/gitinspector
1
0
Fork 0
mirror of https://github.com/ejwa/gitinspector.git synced 2024-12-31 18:02:15 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fixed remaining issues in README.md

Browse source 
The logo and example thumbnail are now integrated into the page more nicely.
Also, links to the wiki were not properly defined.
This commit is contained in:
Adam Waldenberg 2015-08-25 15:16:19 +02:00
parent edf1843300
commit 42b2288c85
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,12 +1,16 @@
<h2><img valign="center" src="https://raw.githubusercontent.com/ejwa/gitinspector/master/gitinspector/html/gitinspector_piclet.png" /> About Gitinspector</h2>
<img style="float:right;" src="https://raw.github.com/wiki/ejwa/gitinspector/images/html_example_thumbnail.jpg" />
<h2>
<img align="left" height="30px"
src="https://raw.githubusercontent.com/ejwa/gitinspector/master/gitinspector/html/gitinspector_piclet.png"/>
&nbsp;About Gitinspector
</h2>
<img align="right" width="30%" src="https://raw.github.com/wiki/ejwa/gitinspector/images/html_example.jpg" />
Gitinspector is a statistical analysis tool for git repositories. The defaut analysis shows general statistics per author, which can be complemented with a timeline analysis that shows the workload and activity of each author. Under normal operation, it filters the results to only show statistics about a number of given extensions and by default only includes source files in the statistical analysis.
This tool was originally written to help fetch repository statistics from student projects in the course Object-oriented Programming Project (TDA367/DIT211) at Chalmers University of Technology and Gothenburg University.
Today, gitinspector is used as a grading aid by universities worldwide.
Please refer to the [[FAQ]] for help on the most common questions.
Please refer to the [FAQ](https://github.com/ejwa/gitinspector/wiki/FAQ) for help on the most common questions.
### Some of the features
* Shows cumulative work by each author in the history.
@ -37,8 +41,7 @@ Below are some example outputs for a number of famous open source projects. All
* Sergei Lomakov, Russian translation
* Yannick Moy, French translation
*We need translations for gitinspector!* If you are a gitinspector user, feel willing to help and have good language skills in any unsupported language we urge you to contact us. We also happily accept code patches. Please refer to [[Contributing]] for more information on how to contribute to the project.
*We need translations for gitinspector!* If you are a gitinspector user, feel willing to help and have good language skills in any unsupported language we urge you to contact us. We also happily accept code patches. Please refer to [Contributing](https://github.com/ejwa/gitinspector/wiki/Contributing) for more information on how to contribute to the project.
### License
gitinspector is licensed under the *GNU GPL v3*. The gitinspector logo is partly based on the git logo; based on the work of Jason Long. The logo is licensed under the *Creative Commons Attribution 3.0 Unported License*.