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.

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

Tweak build instructions #1048

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

RandomInEqualities
Copy link
Contributor

I have these 3 commits that mostly tweaks the windows build instructions to have less text and be more focused. It is easy to build with Visual Studio/Clang/GCC on Windows, but there is a lot of text making it seem complicated. With CMake things are quite simple.

This mainly does 3 things:

  • Rename README.windows to README.mingw.md as it is largely only mingw related.
  • Remove dist-win.sh script as I think CMake does this better. And dist-win relies on mingw while there are native compiler support. The releases.yml also uses CMake.
  • Moves things around in README.md to make it focused on CMake or configure based on what one want to use.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@joshuasing joshuasing requested a review from busterb May 24, 2024 05:51
With the CMake version of building for windows
there is support for building with MINGW, clang,
and Visual Studio. CMake can build for MINGW
using the regular method of autogen and CMake.

Removing this makes it a bit simpler to get an
overview of how to build for windows. Reducing
confusion.
Since it is mingw specific and does not really
involve other compilers.
In particular simplify the Windows build instructions,
by only having a short CMake section about it. While
mentioning that bash shell is required also on Windows
up-front.

Splits the build section into a section for configure
and one for CMake so it is easier to pick one of them.
Moves the additional CMake options into the CMake section.
Moves dist.sh text into the configure section as it is
configure specific.
@RandomInEqualities
Copy link
Contributor Author

Thanks for the comments @joshuasing I have updated the review :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants