สำหรับเอกสารประกอบเฉพาะของ Vulkan ® API โปรดดูที่ READMEVK.adoc
สำหรับเอกสารเฉพาะของ Vulkan ® SC API โปรดดูที่ READMESC.adoc
โครงสร้างไดเรกทอรีเป็นดังนี้:
README.adoc This file
READMESC.adoc Readme for the Vulkan SC specification
READMEVK.adoc Readme for the Vulkan specification
BUILD.adoc Documents how to build the specifications and reference pages
CONTRIBUTING.adoc Requirements for external contributions to the repository
COPYING.adoc Copyright and licensing information
CODE_OF_CONDUCT.adoc Code of Conduct
LICENSE.adoc Summary of licenses used by files in the repository
ChangeLog.adoc Change log summary for each public Vulkan spec update
ChangeLogSC.adoc Change log summary for each public Vulkan SC spec update
Makefile, make* Makefile and helper build scripts (see BUILD.adoc)
antora/ Staging area for the docs.vulkan.org Antora 'proposals' and 'spec' modules
appendices/ Specification appendices
chapters/ Specification chapters
proposals/ Design documents for extensions
config/ Asciidoctor configuration, CSS, and index generator
images/ Images (figures, diagrams, icons)
gen/out/ Default directory for the generated documents
scripts/ Helper scripts used in specification, header, and reference page generation
style/ Sources for "styleguide" (Vulkan Documentation and Extensions: Procedures and Conventions)
xml/ XML API Registry (`vk.xml`) as well as XML for non-Vulkan
data structures used with Video extensions (`video.xml`)
registry.adoc Source for documentation of the XML format แหล่งที่มาของเอกสารถูกมาร์กอัปในรูปแบบ Asciidoctor และเราใช้ asciidoctor และส่วนประกอบ toolchain ที่เกี่ยวข้องเพื่อสร้างเอกสารเอาต์พุต ดู BUILD.adoc สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการติดตั้ง toolchain และการสร้างข้อกำหนด
ดูxml/README.adoc
ไฟล์ส่วนหัว ( include/vulkan/vulkan*.h ) และหลายส่วนของข้อกำหนดคุณสมบัติและเอกสารหน้าอ้างอิงถูกสร้างขึ้นจากคำอธิบายใน XML API Registry ( xml/vk.xml ) ไฟล์ที่สร้างขึ้นจะไม่ถูกเช็คอินในที่เก็บ หากคุณเปลี่ยน vk.xml คุณสามารถสร้างส่วนหัวใหม่ได้โดยไปที่ xml/ และเรียกใช้:
$ ทำการติดตั้งใหม่ทั้งหมด
ไฟล์ที่สร้างขึ้นอื่นๆ ถูกสร้างขึ้นตามความต้องการผ่านการพึ่งพาใน Makefile ระดับบนสุด
