csimonis/gitfiti
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Update README.md

Browse Source
This commit is contained in:
Eric
2013-04-30 14:00:18 -03:00
parent 8c62871c55
commit ded8c6d347
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,10 +1,11 @@
##gitfiti gitfiti _noun_ : carefully crafted griffiti in a github commit history calendar.
gitfiti is a tool I wrote to (blatantly) abuse your github account's commit history calendar.
`gitfiti.py` is a tool I wrote to (blatantly) abuse your github account's commit history calendar.
I highly recommend that you create a _new_ github repo when using gitfiti. I highly recommend that you create a _new_ github repo when using gitfiti.
###Usage: ###Usage:
1. create a new github repo to store your handiwork. 1. Create a new github repo to store your handiwork.
2. Run `gitfiti.py` and follow the prompts for username, art selection, offset, and repo name. 2. Run `gitfiti.py` and follow the prompts for username, art selection, offset, and repo name.
3. Run the generated `gitfiti.sh` from your home directory (or any non-git tracked dir) and watch it go to work. 3. Run the generated `gitfiti.sh` from your home directory (or any non-git tracked dir) and watch it go to work.
4. Wait... Seriously, you'll probably need to wait a day or two for the gitfiti to show in your commit graph. 4. Wait... Seriously, you'll probably need to wait a day or two for the gitfiti to show in your commit graph.