Skip to content

Add a linked quick reference for setup ordering and file paths #53

Closed

Description

@sean-parent

Split from #14's still-current documentation discoverability suggestions.

Reader task

A new consumer author should be able to find the required CMake version, dependency/setup ordering, public entry points, and file-resolution conventions without scanning the entire README.

Dependency tracking is already explained in examples and prose (README.md:118-122, README.md:274-286); the file conventions appear later (README.md:601-608). Improve navigation rather than treating those explanations as absent.

Scope and acceptance

  • Add a compact, linked quick reference for the required CMake version and principal public functions.
  • Give cpp_library_enable_dependency_tracking() an API-reference entry explaining its required position before the literal project() call.
  • Link the HEADERS, SOURCES, TESTS, and EXAMPLES resolution rules near the first setup example.
  • Link existing detailed sections instead of maintaining duplicate instructions.
  • Preserve the installation guidance from Fix installation support, project isolation, and public-header checks #47: ordinary CPM libraries need no manual shared-option initialization or export workarounds.

Activity

  1. added a commit that references this issue on Nov 19, 2026
    cd4cc08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions