From a0dcc74349fa29fd17920bb0280dddd0471763ea Mon Sep 17 00:00:00 2001 From: Brooke <12855764+goingforbrooke@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:37:24 -0700 Subject: [PATCH] Doc: Add `python2` and `python3` example commands Running Gitfiti with `./gitfiti.py` isn't an option because the shebang `#!/usr/bin/env python` needs to remain compatible with Python 2 and Python 3. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 1773d9136..1daa6f4ad 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,37 @@ Included "art" from left to right: kitty, oneup, oneup2, hackerschool, octocat, 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. + +For Python 3, use `python3`. + +```console + $ python3 ./gitfiti.py + + _ __ _____ __ _ + ____ _(_) /_/ __(_) /_(_) + / __ `/ / __/ /_/ / __/ / + / /_/ / / /_/ __/ / /_/ / + \__, /_/\__/_/ /_/\__/_/ + /____/ + + Enter GitHub URL (leave blank to use https://github.com/): +``` + +For Python 2, use `python2`. + +```console + $ python2 ./gitfiti.py + + _ __ _____ __ _ + ____ _(_) /_/ __(_) /_(_) + / __ `/ / __/ /_/ / __/ / + / /_/ / / /_/ __/ / /_/ / + \__, /_/\__/_/ /_/\__/_/ + /____/ + + Enter GitHub URL (leave blank to use https://github.com/): +``` + 3. Run the generated `gitfiti.sh` or `gitfiti.ps1` 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.