共用方式為

為您的埠提供使用量檔

  • 發行項

概觀

提供埠的使用檔可讓用戶在專案中輕鬆採用它們。 我們強烈建議在埠目錄內提供檔案 usage ，ports/<port name>/usage以描述與建置系統整合所需的最少步驟。

提供使用檔案

若要提供使用檔，請在埠的安裝目錄中建立名為 usage 的 share 文字檔。 建議的方法是在 中portfile.cmake呼叫 函configure_file()式。

例如：

configure_file("${CMAKE_CURRENT_LIST_DIR}/usage" "${CURRENT_PACKAGES_DIR}/share/${PORT}/usage" COPYONLY)

安裝埠之後，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)