Skip to content

Include Windows setup instructions in README #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mustapure wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Include Windows setup instructions in README #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,15 @@ make docker-run
git clone https://github.com/evolution-foundation/evolution-go.git
cd evolution-go

# Setup, configure and run
# Setup, configure and run
make setup
cp .env.example .env
make dev
```
# Setup, configure and run for windows
make setup
copy .env.example .env
make dev
Comment on lines +76 to +79

@sourcery-ai sourcery-ai Bot Sep 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: The Windows instructions invoke make setup and make dev without specifying WSL, Git Bash, or another POSIX shell, but the setup target runs the swagger recipe using POSIX shell syntax (if command -v ...; then), which fails when GNU Make uses the native Windows command shell.

Triggers: When a user follows these steps from native Windows Command Prompt with Make installed but without a POSIX-compatible shell.

Suggested fix: State that the commands must be run in WSL/Git Bash, or provide a native Windows setup path and Windows-compatible Make recipes.

Suggested change
# Setup, configure and run for windows
make setup
copy .env.example .env
make dev
# Setup, configure and run for Windows (using WSL or Git Bash)
make setup
cp .env.example .env
make dev


Comment on lines +76 to 80

@sourcery-ai sourcery-ai Bot Sep 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: The Windows heading and its commands are placed after the closing Markdown code fence, so make setup, copy .env.example .env, and make dev render as ordinary paragraph text rather than a copyable command block.

Suggested fix: Add a separate fenced code block around the Windows heading and commands, or move the heading outside the block and wrap only the commands in a Windows-compatible fence.

> Run `make help` to see all available commands. See [COMMANDS.md](./COMMANDS.md) for detailed workflows.

Expand Down