mapbox / mapbox/cpp

Documentation of mason.cmake

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
110
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Reminder to write documentation for how to use:

- Mason packages within cmake `CMakelists.txt`
- Specifically the variables and functions made available by `mason.cmake`

Current users of this methodology we can point to as examples are `mapbox-gl-native`, `osrm-backend`, and https://github.com/mapbox/rewrite-exit-destination-signage.

/cc @karenzshea

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read mason.cmake to identify the variables and functions it exposes for use in CMakeLists.txt. Compare its usage in mapbox-gl-native, osrm-backend, and rewrite-exit-destination-signage, then document the setup and available interfaces with those projects as examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.