포트에 대한 사용 설명서 제공

개요

포트에 대한 사용 설명서를 제공하면 사용자가 프로젝트에서 쉽게 채택할 수 있습니다. 빌드 시스템과의 통합에 필요한 최소 단계를 설명하는 파일을 포트의 디렉터리(usage) 내에 제공하는 것을 강력히 권장합니다.

사용량 파일 제공

사용 설명서를 제공하려면 포트의 usage 설치 디렉터리에 명명된 share 텍스트 파일을 만듭니다. 권장되는 방법은 file(INSTALL ...)에서 portfile.cmake 함수를 호출하는 것입니다.

다음은 그 예입니다.

file(INSTALL "${CMAKE_CURRENT_LIST_DIR}/usage" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}")

포트를 설치한 후 vcpkg는 설치된 ${CURRENT_PACKAGES_DIR}/share/${PORT}/usage 파일을 검색하고 사용 지침을 출력합니다.

콘텐츠 형식

패키지를 사용하는 방법에 대한 명확한 지침을 제공합니다. 콘텐츠는 간결하고 잘 구성되어야 하며 라이브러리를 사용하는 데 필요한 최소 빌드 시스템 통합을 강조해야 합니다.

패키지를 효과적으로 활용하는 방법에 대해 명확하고 간결하게 설명합니다. 코드 조각, 명령줄 지침 또는 구성 세부 정보를 사용하여 사용자를 압도하지 않도록 합니다. 대신 사용자가 라이브러리에 대해 자세히 알아볼 수 있도록 포트 파일의 "documentation" 속성을 사용합니다vcpkg.json.

다음 템플릿을 파일에 대한 usage 패턴으로 사용합니다.

CMake 대상이 있는 패키지:

<port> provides CMake targets:

  <instructions>

헤더 전용 라이브러리:

<port> is header-only and can be used from CMake via:

  <instructions>

파일 usage의 예시

proj provides CMake targets:

  find_package(PROJ CONFIG REQUIRED)
  target_link_libraries(main PRIVATE PROJ::proj)