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

Simplify and update build instructions for windows and update docs #153

Merged
merged 2 commits into from
Dec 2, 2023

Conversation

ronald-jaepel
Copy link
Collaborator

@ronald-jaepel ronald-jaepel commented Nov 17, 2023

Based on #130

Current ToDos:

  • Automatically update build instructions in the documentation based on build instructions in the repo-root markdown files
  • Update Linux and OSX build instructions based on CI pipeline
  • Update Windows build instructions based on CI pipeline, with optional modifications(?)
  • Set ENABLE_THREADING to OFF via env variable by default in all build instructions

@ronald-jaepel
Copy link
Collaborator Author

Because of a cryptic vcpkg package download error when using vcpkg on the github CI pipeline, I've reverted the CI instructions to their previous state. They work, so I don't see an urgent need to change them. With this change, the branch should be ready for review.

- update build worflow to use vcpkg
- update build instructions
- remove redundant build instructions by linking to the build guides in root from the documentation
- update FindXXX.cmake to better handle windows paths
- update FindUMFPACK.cmake to include GKlib
@ronald-jaepel ronald-jaepel force-pushed the feature/update_build_windows_and_docs branch from 3db5896 to b6e0569 Compare November 20, 2023 18:34
@ronald-jaepel
Copy link
Collaborator Author

Also squashed into one commit.

Copy link
Contributor

@schmoelder schmoelder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ronald-jaepel for working on this. I think this greatly improves the build guide! Also good idea to unify the documentation and repo instructions!

I only have some minor comments, mostly they are due to personal preferences but I thought, I'd add them anyways.

BUILD-LINUX.md Outdated Show resolved Hide resolved
BUILD-LINUX.md Outdated Show resolved Hide resolved
BUILD-LINUX.md Outdated Show resolved Hide resolved
BUILD-LINUX.md Outdated Show resolved Hide resolved
doc/conf.py Show resolved Hide resolved
@ronald-jaepel ronald-jaepel force-pushed the feature/update_build_windows_and_docs branch from 06d5a13 to e118337 Compare December 1, 2023 15:14
@ronald-jaepel ronald-jaepel force-pushed the feature/update_build_windows_and_docs branch from e118337 to 6866c25 Compare December 1, 2023 15:58
@ronald-jaepel
Copy link
Collaborator Author

@schmoelder All requested changes have been addressed. Imo this branch is ready to be merged.

@schmoelder schmoelder self-requested a review December 2, 2023 06:52
@schmoelder
Copy link
Contributor

LGTM! :)

@schmoelder schmoelder merged commit c2ef5fc into master Dec 2, 2023
3 checks passed
@schmoelder schmoelder deleted the feature/update_build_windows_and_docs branch December 2, 2023 06:58
@jbreue16 jbreue16 mentioned this pull request Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants