Skip to content
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

Update README.md to include Windows GCC setup instructions #1312

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

Update README.md to include Windows GCC setup instructions #1312

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,30 @@ Static compilation command, meant to be used alongside the prebuilt librdkafka b
CC=/path/to/musl-gcc go build --ldflags '-linkmode external -extldflags "-static"' -tags musl
```

Windows Requirements
----------------------

Since Go needs to link with librdkafka, you need to have a native Windows version of `gcc` installed on your machine.
If you don't have `gcc` installed, you'll get a bunch of "undefined" messages, such as `undefined: kafka.NewProducer`,
even though you've properly imported the Confluent Kafka module.

Windows `gcc` setup using MSYS2:

1. Install MSYS2 from https://www.msys2.org/
2. Open the "MSYS2 UCRT64" application. Enter the following commands into the $ prompt:
3. `pacman -Syu`
(You will likely need to run this multiple times)
4. `pacman -S base-devel`
5. `pacman -S mingw-w64-x86_64-toolchain`
6. `pacman -Q -e`
7. `pacman -S mingw-w64-ucrt-x86_64-gcc`
8. Add the full path to `msys64\mingw64\bin` to your PATH environment variable. For example,
if you installed MSYS2 to "C:\Program Files\msys64", then add "C:\Program Files\msys64\mingw64\bin" to your
system PATH environment variable.
9. Close then reopen any command line windows or your IDE so that they pick up the new PATH.
10. Now if you do `go build ./...` on your project, it will take a few minutes to compile, but should work.


API Strands
===========

Expand Down