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

Add more detailed docs for building cmake-based AFDKO from source #1384

Merged
merged 2 commits into from
Jul 26, 2021

Conversation

iterumllc
Copy link
Collaborator

Description

The Antlr 4 Cpp runtime adds a guid/uuid to some elements of its parsers. It can satisfy that dependency with built-in parts of macOS and Windows but on other OSes libuuid and its headers must be installed (it uses pkg_check_modules(UUID REQUIRED uuid) in CMakeLists.txt on Linux).

This is effectively another "build tools" requirement and will already be satisfied on many systems, but some users will need to install an extra package or, possibly in rare cases, install libuuid from source. This PR adds some documentation to that effect. There's also some doc cleanup here and there.

Checklist:

  • I have followed the Contribution Guidelines
  • I have added test code and data to prove that my code functions correctly
  • I have verified that new and existing tests pass locally with my changes
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

README.md Show resolved Hide resolved
kaydeearts
kaydeearts previously approved these changes Jun 21, 2021
Copy link
Collaborator

@kaydeearts kaydeearts left a comment

Choose a reason for hiding this comment

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

👍 Looks good!

Copy link
Collaborator

@josh-hadley josh-hadley left a comment

Choose a reason for hiding this comment

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

👍

@kaydeearts kaydeearts merged commit 758089f into adobe-type-tools:develop Jul 26, 2021
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.

4 participants