次の方法で共有


ポートの使用状況に関するドキュメントを提供する

概要

ポートの使用に関するドキュメントを提供すると、ユーザーはプロジェクトでそれらを簡単に採用できます。 ビルド システムとの統合に必要な usage 最小限の手順を説明するポートのディレクトリ (ports/<port name>/usage) 内にファイルを提供することを強くお勧めします。

使用状況ファイルの指定

使用ドキュメントを提供するには、ポートshareのインストール ディレクトリに名前を付けたusageテキスト ファイルを作成します。 推奨される方法は、次の関数portfile.cmakeconfigure_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)