commit-heatmap-gen

commit heatmap generator
git clone git://brookjeynes.dev/bjeynes/commit-heatmap-gen.git
Log | Files | Refs | README | LICENSE

README (654B)

      1 commit heatmap generator
      2 ------------------------
      3 
      4 Generate a commit heatmap web-component akin to GitHub's contributions heatmap.
      5 
      6 This is calculated by counting the number of commits authored by the provided
      7 email in HEAD. This will not pick-up commits in deleted branches or squashed
      8 commits.
      9 
     10 
     11 Usage
     12 -----
     13 
     14 Generate the web-component:
     15 
     16 	$ commit-heatmap-gen git@email.com path/to/gitdir > commit-heatmap.js
     17 
     18 Include the generated JS file into your websites <head>:
     19 
     20 	<script src="commit-heatmap.js"></script>
     21 
     22 Use the web-component:
     23 
     24 	<commit-heatmap></commit-heatmap>
     25 
     26 
     27 Dependencies
     28 ------------
     29 
     30 - C compiler
     31 - libc
     32 - libgit2
     33 
     34 
     35 Build
     36 -----
     37 
     38 $ make