Because the README.md provides text for the face of the Python package landing page, it should contain an "Installation Notes" section.
It should probably go above the Example section, so that it is attention of the user, because they will not be able to do the example until they install.
It is worth pointing out that the user will need to have a C compiler installed for pip install planarity to succeed, such as clang on MacOS, MinGW gcc or Microsoft cl on Windows, or gcc on Linux. We don't need to go into versions, and its kind of obvious on Linux, but on Windows and MacOS, it is an extra requirement for Python developers. (May be able to mitigate in future releases with some binary wheels for Windows and Mac).
More importantly, this is the place to explain that a Windows user with MinGW gcc only needs to run the following variant of the pip install command:
pip install planarity --config-settings="--build-option=build_ext" --config-settings="--build-option=--compiler=mingw32"
Because the README.md provides text for the face of the Python package landing page, it should contain an "Installation Notes" section.
It should probably go above the Example section, so that it is attention of the user, because they will not be able to do the example until they install.
It is worth pointing out that the user will need to have a C compiler installed for
pip install planarityto succeed, such as clang on MacOS, MinGW gcc or Microsoft cl on Windows, or gcc on Linux. We don't need to go into versions, and its kind of obvious on Linux, but on Windows and MacOS, it is an extra requirement for Python developers. (May be able to mitigate in future releases with some binary wheels for Windows and Mac).More importantly, this is the place to explain that a Windows user with MinGW gcc only needs to run the following variant of the pip install command:
pip install planarity --config-settings="--build-option=build_ext" --config-settings="--build-option=--compiler=mingw32"