Create/expand docs explaining options
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 296
- Forks
- 66
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 1
Description
We could better explain general best practices for CMake options and how the options in BLT work/expected to be used.
* Add all options in BLT to a table and explain them
* Add example about how to use ENABLE_TESTS (and examples) with explanation about how to do project level dependent options (ie AXOM_ENABLE_TESTS) for when your project is included in another via add_subdirectory
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating BLT's current option definitions and existing documentation, then inventory every BLT option for the requested table. Review how ENABLE_TESTS is currently used and document an example, including project-level dependent options such as AXOM_ENABLE_TESTS when a project is included with add_subdirectory. Done means the options, usage guidance, and examples are covered clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100