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

Added documentation for installing Command Line Tools #4987

Closed
wants to merge 1 commit into from

Conversation

carolinekraus02
Copy link

I added documentation describing how to install automake, libtool, cmake, pkg-config, wget, and meson and included some common pitfalls and solutions for those processes. This will improve contributors' understanding because the installation prerequisites are more explicitly explained.

Copy link
Member

@t-paul t-paul left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good to me, but I have not touched macOS / Homebrew for a long time. @kintel?

@kintel
Copy link
Member

kintel commented Feb 18, 2024

Added some comments - the instructions are an odd mix of using Linux, Windows and macOS tools to install dependencies on macOS. Needs to either be cleaned up, or split up into sections for each OS.

@@ -141,8 +141,38 @@ To pull the various submodules (incl. the [MCAD library](https://github.com/open
Prerequisites:

* Xcode
Terminal tools
Copy link
Member

Choose a reason for hiding this comment

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

-> Xcode command-line tools

* In terminal, run: brew install automake
libtool
* In terminal, run: brew install libtool
* May have to use "glibtool" instead on some newer versions of MacOSX
Copy link
Member

Choose a reason for hiding this comment

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

Could you explain this a bit better? On what version of macOS is glibtool available on homebrew?

* Install using: sudo mkdir /opt/cmake
* Finish install; sudo sh <installer filename> --prefix=/opt/cmake
* Common issues with cmake: version too outdated or filepaths contain unecessary spaces
* If issues persist, visit this resource https://hsf-training.github.io/hsf-training-cmake-webpage/07-commonproblems/index.html
Copy link
Member

Choose a reason for hiding this comment

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

The cmake instructions seem to be a mixture or macOS and Linux instructions. Why would we use apt purge on macOS?

* Common error returned: "error cannot open file '_____.lib'"
* To address this, make sure the proper language is installed
* Ex.: for C++ projects, install Visual C++ for Desktop Development
* In Visual Studio: Installed > Change Installed VS CE > Workloads > Desktop Development with C++ > apply and save
Copy link
Member

Choose a reason for hiding this comment

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

Why mention Visual Studio in macOS install instructions?

@kintel
Copy link
Member

kintel commented Mar 22, 2024

Closing due to lack of feedback

@kintel kintel closed this Mar 22, 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.

None yet

3 participants