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

Document how to install CommonMark on newer Macs #3137

Merged
merged 1 commit into from
Aug 5, 2024
Merged

Conversation

oalders
Copy link
Member

@oalders oalders commented Jul 21, 2024

No description provided.

Copy link

codecov bot commented Jul 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.94%. Comparing base (896e21d) to head (64f2a46).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3137   +/-   ##
=======================================
  Coverage   72.94%   72.94%           
=======================================
  Files          69       69           
  Lines        2391     2391           
  Branches      338      338           
=======================================
  Hits         1744     1744           
  Misses        520      520           
  Partials      127      127           

@oalders oalders force-pushed the oalders/commonmark branch 3 times, most recently from 88b77c8 to e402e4e Compare July 21, 2024 16:32
README.md Outdated
If you like, you can install the `cmark` C libraries via Homebrew:

```bash
brew install cmark
Copy link
Member

Choose a reason for hiding this comment

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

I think this may be better left as part of the brew install carton command. The elaboration added in this PR doesn't change anything about how cmark is installed, just how it's used. And it should generally be installed before running carton.

Linking against the version specific paths shouldn't be needed and will be fragile. Upgrades could lead to breaking your build. So I'd rather list it as a fallback in case the normal path didn't work rather than the expected path.

@haarg
Copy link
Member

haarg commented Jul 22, 2024

So I've figured out what allowed this to work fine for me on my system. I have LIBRARY_PATH and CPATH set to allow compiling against the homebrew libraries.

LIBRARY_PATH=/opt/homebrew/lib CPATH=/opt/homebrew/include cpm install -g CommonMark is likely a better command to recommend.

@oalders oalders force-pushed the oalders/commonmark branch from e402e4e to 64f2a46 Compare August 5, 2024 16:32
@oalders
Copy link
Member Author

oalders commented Aug 5, 2024

@haarg this is ready for another review.

@oalders oalders merged commit ff2b8ff into master Aug 5, 2024
10 checks passed
@oalders oalders deleted the oalders/commonmark branch August 5, 2024 20:09
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.

2 participants