docs: Add instructions for installing on Windows#91
docs: Add instructions for installing on Windows#91coding-snake wants to merge 1 commit intogittower:mainfrom
Conversation
Adds instructions on how to install git-flow-next on Windows, including a method for verifying the installation. The installation instructions are mostly the same as for manual installation, but with the extra step of changing the name of the binary and skipping the use of the chmod command due to Windows not having a native chmod command.
There was a problem hiding this comment.
Pull request overview
Adds Windows-specific manual installation instructions for git-flow-next to the README so Windows users can install the binary as a Git subcommand and verify it works.
Changes:
- Added a “Manual Installation (Windows)” section under Installation.
- Added a verification flow with example error output for misinstallation/renaming.
| #### 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 |
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.
| 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 | ||
| ```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 |
There was a problem hiding this comment.
git: 'flow' is not a git command generally means Git cannot find a git-flow(.exe) executable on PATH (or in Git’s exec-path), not only that it was renamed incorrectly. It may be worth mentioning checking that the directory containing git-flow.exe is actually on PATH (and that the terminal session was restarted) in addition to the rename step.
| ```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 | ||
| ```bash | ||
|
|
||
| The most similar command is | ||
| flow.exe | ||
| ``` |
There was a problem hiding this comment.
Both fenced blocks are showing console output rather than shell commands, but they’re marked as bash. Using an untyped fence or text would avoid misleading syntax highlighting (and the second block also starts with a blank line).
|
|
||
| 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”.
| 3. Change name of the binary to `git-flow.exe` | |
| 3. Rename the binary to `git-flow.exe` |
alexrinass
left a comment
alexrinass
left a comment
There was a problem hiding this comment.
Thanks for contributing Windows installation docs — this is a useful addition. The commit message follows project conventions well. The core instructions (download, extract, rename) are correct, but the troubleshooting section is too verbose for a README and there are some markdown rendering issues.
Must Fix
- Fenced code blocks inside numbered lists must be indented to stay within the list —
README.md:55,59— without indentation, the code blocks break out of the list and steps 5/6 will render with broken numbering on GitHub. Simplifying the verification section (see below) would also resolve this.
Should Fix
- Section structure —
README.md:45— "### Manual Installation (Windows)" right before "### Manual Installation" is confusing. Move the Windows section after the existing manual installation section (macOS/Linux is the more common target), and rename the existing section to "### Manual Installation (macOS and Linux)" for symmetry. - Trim the verification/troubleshooting section —
README.md:54-63— the.exe.exetroubleshooting covers a rare edge case and adds a lot of visual weight for a README. A single sentence noting that the binary must be named exactlygit-flow.exeis sufficient. - Grammar: "Change name of the binary" —
README.md:49— should be "Rename the binary togit-flow.exe". - Grammar: "If you see message similar" —
README.md:54— missing article ("a message").
Nit
- Informal tone ("there is a chance", "the clue might be") is slightly casual for project docs. Consider more direct phrasing.
🤖 Review generated with Claude Code
| ```bash | ||
| brew install gittower/tap/git-flow-next | ||
| ``` | ||
| ### Manual Installation (Windows) |
There was a problem hiding this comment.
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.
| #### 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 |
There was a problem hiding this comment.
The .exe.exe troubleshooting (steps 5-6 with code blocks) covers a rare edge case and adds a lot of visual weight. Consider simplifying to something like:
#### 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).
Adds instructions on how to install git-flow-next on Windows, including a method for verifying the installation. The installation instructions are mostly the same as for manual installation, but with the extra step of changing the name of the binary and skipping the use of the chmod command due to Windows not having a native chmod command.