diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d4270e --- /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.6