Freigeben über

Bereitstellen der Verwendungsdokumentation für Ihre Ports

  • Artikel

Übersicht

Die Bereitstellung von Verwendungsdokumentationen für Ports ermöglicht benutzern die einfache Einführung in ihre Projekte. Wir empfehlen dringend, eine usage Datei im Portverzeichnis (ports/<port name>/usage) bereitzustellen, die die minimalen Schritte beschreibt, die für die Integration in ein Buildsystem erforderlich sind.

Bereitstellen einer Verwendungsdatei

Erstellen Sie zum Bereitstellen der Verwendungsdokumentation eine Textdatei, die im Installationsverzeichnis des share Ports benannt usage ist. Die empfohlene Methode besteht darin, die configure_file() Funktion in portfile.cmakeaufzurufen.

Zum Beispiel:

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

Nach der Installation von Ports erkennt vcpkg Dateien, die installiert ${CURRENT_PACKAGES_DIR}/share/${PORT}/usage sind, und druckt ihre Verwendungsanweisungen.

Inhaltsformat

Stellen Sie klare Anweisungen zur Verwendung des Pakets bereit. Der Inhalt sollte präzise, gut strukturiert sein und die minimale Buildsystemintegration hervorheben, die für die Verwendung der Bibliothek erforderlich ist.

Seien Sie klar und präzise darüber, wie Sie das Paket effektiv nutzen können. Vermeiden Sie es, dass Benutzer mit Codeausschnitten, Befehlszeilenanweisungen oder Konfigurationsdetails überwältigen. Verwenden Sie stattdessen die "documentation" Eigenschaft in der Portdateivcpkg.json, damit Benutzer mehr über Ihre Bibliothek erfahren können.

Verwenden Sie die folgenden Vorlagen als Muster für Ihre usage Dateien:

Pakete mit CMake-Zielen:

<port> provides CMake targets:

    <instructions>

Nur Kopfzeilenbibliotheken:

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

    <instructions>

Beispiel für usage eine Datei

proj provides CMake targets:

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