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

Update building.md to include instructions on installing clang-format #6595

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

kraenhansen
Copy link
Member

What, How & Why?

With the merge of realm/realm-core#7554 we'll need to ensure that our machines has a clang-format executable installed for the bindgen tool to invoke when generating C++ binding code.

@kraenhansen kraenhansen requested a review from elle-j April 4, 2024 22:15
@kraenhansen kraenhansen self-assigned this Apr 4, 2024
@cla-bot cla-bot bot added the cla: yes label Apr 4, 2024
@kraenhansen kraenhansen requested a review from kneth April 4, 2024 22:15
@kraenhansen kraenhansen added no-changelog no-jira-ticket Skip checking the PR title for Jira reference labels Apr 5, 2024
@@ -43,14 +43,15 @@ The following dependencies are required. All except Xcode can be installed by fo
- [Xcode](https://developer.apple.com/xcode/) latest Xcode with command line tools installed
- The latest Xcode should work, which can be downloaded from [Mac App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12). To install older Xcode versions, [Xcodes.app](https://github.com/RobotsAndPencils/XcodesApp) is highly recommended
- [Node.js](https://nodejs.org/en/) version 16 or later
- We recommend [using NVM](https://github.com/nvm-sh/nvm#installing-and-updating) to enable fast switching between Node.js & NPM versions
- We recommend [fnm](https://github.com/Schniz/fnm) or [NVM](https://github.com/nvm-sh/nvm#installing-and-updating) to enable fast switching between Node.js & NPM versions
Copy link
Member Author

Choose a reason for hiding this comment

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

Sneaking in this too ... it's working great so far 🙈

Copy link
Member

Choose a reason for hiding this comment

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

It sounds like the rest of us should try fnm soon ;-)

@kraenhansen kraenhansen merged commit 0bd8ee4 into main Apr 5, 2024
5 of 8 checks passed
@kraenhansen kraenhansen deleted the kh/clang-format-in-building-docs branch April 5, 2024 08:06
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes no-changelog no-jira-ticket Skip checking the PR title for Jira reference T-Doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants