Skip to content

Conversation

@gaurav02081
Copy link

@gaurav02081 gaurav02081 commented Dec 24, 2025

[IMPROVEMENT]

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.
  • I have mentioned this change in the changelog.

My familiarity with the project is as follows (check one):

  • I have never used CCExtractor.
  • I have used CCExtractor just a couple of times.
  • I absolutely love CCExtractor, but have not contributed previously.
  • I am an active contributor to CCExtractor.

PR Summary

This PR documents the macOS -system-libs build mode introduced in #1862, which enables building CCExtractor using system-installed libraries instead of bundled dependencies.

This mode is required for Homebrew compatibility and uses pkg-config to link against Homebrew-provided libraries (e.g. gpac, freetype, libpng, zlib). The default bundled build remains unchanged.

The documentation explains:

When to use the default vs -system-libs build

Required Homebrew dependencies

How to verify the build

CI coverage for the system-libs path

This provides a clear upstream reference for package managers and unblocks future Homebrew formula work.

@x15sr71
Copy link
Contributor

x15sr71 commented Dec 24, 2025

Thanks for the PR @gaurav-dev02, this documentation is comprehensive and addresses the Homebrew compatibility clearly.
I had a couple of structural suggestions from a maintainability point of view -

  1. Since docs/compilation.md is currently the main entry point for build instructions, i think it might be cleaner to add this section directly there (under macOS) instead of a new standalone file? It might help users find all build options in one place.
  2. Some of the background/history sections could potentially be trimmed to keep the focus on the “how to build” path.

Thanks for unblocking the docs side!

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.

3 participants