Skip to content

Specify package dependency on gcc in Readme #175

Closed
@smile-on

Description

@smile-on

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions