Files
gitfiti/README.md
Eric 3ad59a2a19 Update README.md
updated todo, new screenshot, etc.
2013-05-21 14:24:46 -03:00

37 lines
1.7 KiB
Markdown

gitfiti _noun_ : Carefully crafted graffiti in a github commit history calendar.
An example of gitfiti in the wild:
![alt text](https://raw.github.com/gelstudios/gitfiti/master/gitfiti-screenshot.png "screenshot")
`gitfiti.py` is a tool I wrote to decorate your github account's commit history calendar by (blatantly) abusing git's ability to accept commits _in the past_.
How? `gitfiti.py` generates a bash script: `gitfiti.sh` that makes commits with the GIT_AUTHOR_DATE and GIT_COMMITTER_DATE environment variables set for each targeted pixel.
Since this is likely to clobber repo's history, I highly recommend that you create a _new_ github repo when using gitfiti. Also, the generated bash script assumes you are using public-key authentication with git.
###Pixel Art:
![alt text](https://raw.github.com/gelstudios/gitfiti/master/pixels-large.png "pixel art")
Included "art" from left to right: kitty, oneup, oneup2, hackerschool, octocat, octocat2
###Usage:
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.
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.
###Removal:
Fortunately if you regret your gitfiti in the morning, removing it is fairly easy: delete the repo you created for your gitfiti (and wait).
---
####Todo:
- ~~Remove 'requests' dependency~~
- Web interface
- Load "art" from a file
- Load commit content from a file
- ...
- Profit?
![alt text](http://f.cl.ly/items/0J463J0K1N020S1Q3E3l/er-small.png "tiny logo")