Skip to content
New issue

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

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

Already on GitHub? # to your account

Specify package dependency on gcc in Readme #175

Closed
smile-on opened this issue Feb 13, 2015 · 2 comments
Closed

Specify package dependency on gcc in Readme #175

smile-on opened this issue Feb 13, 2015 · 2 comments

Comments

@smile-on
Copy link

People with different level of knowlege are trying to use it. Please, make README a little more friendly. Now, Installation section of README.md makes illusion of the package as self contained. Please clearly specify dependency on C compiler. An extra line would help to avoid "surprises" and direct people to read FAQ. Here it how this note may look like.

Minimum requirements are Go 1.1+ with CGO enabled and GCC/MinGW C compiler. See "compile" section in FAQ.

Compilation on windows deserves its own section in FAQ. Take a look at Google's sqlite3 package as an example of documenting package dependencies. Short, clear and sets users aware of an extra step.

Windows users should install mingw-w64 (http://mingw-w64.sourceforge.net/), TDM64-GCC (http://tdm-gcc.tdragon.net/), or another MinGW distribution, and make sure that gcc.exe is available from the %PATH%. MSYS is not required.

Thank you for the great package!

@smile-on
Copy link
Author

Just a personal note. MinGW requires a bit of knowlege and effort to get compiler running on windows. Most GO users would just want your package on windows with minimal effort. My personal experience on windows 7 x64 - TDM64-GCC pre-installation is a best choice to have your package up and running. Just download and click. Than go get runs with no issues! Let me know if you'd prefer my changes as a pull request.

@mattn
Copy link
Owner

mattn commented Feb 24, 2015

Could you please send me a pull-request?

gjrtimmer added a commit to gjrtimmer/go-sqlite3 that referenced this issue May 26, 2018
Compile Section Closes mattn#175
Compile Section Closes mattn#201
Compile Section Closes mattn#206
Compile Section Closes mattn#404
Compile Section Closes mattn#217
Compile Section Closes mattn#224
Compile Section Closes mattn#234
Compile Section Closes mattn#242
Feature table Closes mattn#255
Description Section Closes mattn#232
Golang:1.6 not supported Closes mattn#272
Golang:1.5 not supported + compilation section Closes mattn#283
usleep Implemented Closes mattn#285
FAQ Section Closes mattn#289
Compile Section closes mattn#295
FAQ Section Closes mattn#305
PR339 Closes mattn#318 mattn#321
Compilation Section Closes mattn#341
PR407 Closes mattn#364
Feature `sqlite_vtable` Closes mattn#393
Compile Section Closes mattn#416
sqlite_trace feature Closes mattn#433
Compilation Section Closes mattn#435
Compilation Section Closes mattn#443
Golang:1.6 Not Supported Closes mattn#445
Compilation Section Closes mattn#451
Compilation Section Closes mattn#467
Compilation Section Closes mattn#491
Compilation Section Closes mattn#495
Compilation Section Closes mattn#505
Compilation Section Closes mattn#557
Compilation Section Closes mattn#560
@mattn mattn closed this as completed in c9394b1 May 27, 2018
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants