Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8b9903d

Browse files
committed
Updated docs to reflect 3.6 requirement
1 parent 936e3e3 commit 8b9903d

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ If you're making your own level, you may want to consider using this class.
9494
### Creating a skill/level
9595
Creating a skill or level is as easy as running the 'make_level.py' script and filling in the generated template documents. To use the skill/level creator, use the 'make_level.py' script located in the directory containing 'gitgud'. This script can create a skill or level. If you pass the name of a skill that already exists, the level will be created within that existing directory (no duplicate skill directories will be created).
9696

97-
The usage of the script is as follows: "python make_level.py <skill_name> <level_name>".
97+
The usage of the script is as follows: "python3 make_level.py <skill_name> <level_name>".
9898

9999
The script will register the new skill/level to the relevant files (you do not have to worry about this). Additionally, it will create the skill/level directory and template files.
100100

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ If something's missing feel free to add an issue, or if you're interested, view
1111
If you're more of a visual learner, you should start with ["Learn Git Branching"](https://learngitbranching.js.org), and and then give Git Gud a try. Learn Git Branching is more visual, but with Git Gud, you're actually using git to complete the levels.
1212

1313
## How do I use it?
14-
First, no matter what, you'll need Python 3.
14+
First, you'll need to be using a version of Python>=3.6.
1515
We'll use python to install Git Gud.
1616
Depending on which way you want to install, we'll either do a "User install" by downloading the `git-gud` package from PyPi, which is handled by pip, or we'll do an edit-mode (development) install, which also uses pip, but in a different way.
1717
Once it's installed, we make an empty directory and switch into it. We need to do this because Git Gud acts as if we're in a git repository and modifies the files to set up different "levels".
1818
If we were in another directory, it would delete all our files! But don't worry, there's a built in failsafe, so Git Gud will warn us before it does anything like that.
1919

2020
Recap:
2121

22-
1. Install Git Gud using Python 3
22+
1. Install Git Gud using Python>=3.6
2323
2. Create and change into an empty directory for Git Gud to load the skills into
2424
3. Run `git gud init`
2525
4. Follow the instructions to git gud!

0 commit comments

Comments
 (0)