- [1] -> The year you want to push your art to. Yes, GitHub allows commits in the past, making this possible.
- [2] -> The URL of your GitHub repo. This is provided to you when creating the repo. For example, for this repo, the URL is
https://github.com/mattrltrent/github_painter.git
. It's usually referred to as the upstream, or remote, origin. - [3] -> Downloads the script as
github_painter.sh
. - [4] -> Clears the board. Hotkey:
esc
. - [5] -> The palette you can use to draw on the contribution grid. Hotkeys:
space
,a
,s
,d
,f
.
- Add your repo URL to spot [2] seen above. I highly reccomend using a new empty private repo in case something goes wrong.
- Select the year you want to paint to, for the best results, ensure this year is free from commits on your GitHub profile. This tool assumes you have none.
- Paint on the canvas using the different colors, seen as [5] above.
- Download the script, seen as [3] above. You may have to run the command
chmod 701 github_painter.sh
to give executable permission to the file. Then, runsudo ./github_painter.sh
to run the script.
- To delete the art, you can always delete the repository that the commits took place in. This is the easy way out. For more complex cases, refer to this Stack Overflow question.
- If you're not seeing the art appear, please toggle the "Private Contributions" setting on your GitHub profile. It seems to help things sync up:
-
Use at your own risk, because I feel like committing a bunch of times could mess something up if used incorrectly. So, be careful, know what you're doing, and check the outputted
github_painter.sh
script before using it. -
Here's the work-in-progress mobile version repo.