docs: Add instructions for installing on Windows #91
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -42,6 +42,25 @@ Our goal is to contribute back to the developer community with tools that make v | |||||
| ```bash | ||||||
| brew install gittower/tap/git-flow-next | ||||||
| ``` | ||||||
| ### Manual Installation (Windows) | ||||||
|
|
||||||
| 1. Download the latest release from the [releases page](https://github.com/gittower/git-flow-next/releases) | ||||||
| 2. Extract the binary to a location in your PATH | ||||||
| 3. Change name of the binary to `git-flow.exe` | ||||||
|
There was a problem hiding this comment. Minor grammar: “Change name of the binary” would read more naturally as “Rename the binary” or “Change the name of the binary”.
Suggested change
|
||||||
|
|
||||||
| #### Verifying Installation | ||||||
|
|
||||||
| 4. Open the terminal and run `git flow version` | ||||||
| 5. If you see message similar to the one below, there is a chance you didn't rename the binary properly | ||||||
|
Comment on lines
+51
to
+54
There was a problem hiding this comment. The ordered list continues as steps 4–6 under the separate “Verifying Installation” heading, which reads like a new section but renders as a continuation of the same list. Consider starting a new ordered list (restart at 1) or switching the verification steps to bullets so the structure is clearer.
Contributor
There was a problem hiding this comment. The #### Verifying Installation
1. Open a terminal and run `git flow version`
2. If the command is not found, make sure the binary is named exactly `git-flow.exe` (Windows may hide file extensions).This also avoids the fenced-code-block-inside-list rendering issues (the current code blocks aren't indented, so they break list numbering on GitHub). |
||||||
| ```bash | ||||||
| git: 'flow' is not a git command. See 'git --help'. | ||||||
| ``` | ||||||
| 6. The clue might be in the second part of the message, but the most likely scenario is that you accidentally named it `git-flow.exe.exe` due to Windows hiding file extensions | ||||||
|
Comment on lines
+53
to
+58
There was a problem hiding this comment.
|
||||||
| ```bash | ||||||
|
|
||||||
| The most similar command is | ||||||
| flow.exe | ||||||
| ``` | ||||||
|
Comment on lines
+55
to
+63
There was a problem hiding this comment. Both fenced blocks are showing console output rather than shell commands, but they’re marked as |
||||||
|
|
||||||
| ### Manual Installation | ||||||
|
|
||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having two "### Manual Installation" headings at the same level reads oddly. Consider moving the Windows section after the existing manual installation section (macOS/Linux is the more common target) and renaming the existing one to "### Manual Installation (macOS and Linux)" so both sections are clearly scoped.