From 42b2288c85f63db7b19866694503834416d24b65 Mon Sep 17 00:00:00 2001 From: Adam Waldenberg Date: Tue, 25 Aug 2015 15:16:19 +0200 Subject: [PATCH] Fixed remaining issues in README.md The logo and example thumbnail are now integrated into the page more nicely. Also, links to the wiki were not properly defined. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e77833b..0144c16 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -

About Gitinspector

- +

+ +  About Gitinspector +

+ 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*. -