From d6830c9863fe419843f5e09cd14889054ad83e12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9lien=20Nanson?= Date: Tue, 30 May 2017 10:30:40 +0200 Subject: [PATCH 1/2] Add a basic README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..315144d --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Gitstats - meaningful data for your git repository. + +## How to run +1. Clone this repo and `cd` into it +2. Create a output directory for your output +3. `./gitstats [path_to_git_repo] [path_to_output_folder]` +4. Open the `index.html` within your `ouptut_folder` + +## Dependencies + +* Gnuplot + * MacOS: `brew install gnuplot` + * Ubuntu: `sudo apt-get install gnuplot` +* Git +* Python 2.7 From 3115a099af8d3da71a9d36037f27d2773ae46195 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9lien=20Nanson?= Date: Tue, 30 May 2017 10:34:23 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 315144d..8d4270e 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,4 @@ * MacOS: `brew install gnuplot` * Ubuntu: `sudo apt-get install gnuplot` * Git -* Python 2.7 +* Python >= 2.6