Getting Started
===============

This page is the English quick-start path for the ``/en/`` documentation tree.

Install And Build
-----------------

.. code-block:: sh

   cmake -S . -B build
   cmake --build build
   cmake --install build --prefix install

Top-level builds enable ``BUILD_CLI`` by default, so ``featherdoc_cli`` is built
unless ``-DBUILD_CLI=OFF`` is passed explicitly.

PDF support is experimental and opt-in. Build ``FEATHERDOC_BUILD_PDF`` and
``FEATHERDOC_BUILD_PDF_IMPORT`` only when you need the PDF workflow pages and
CLI entry points.

Minimal C++ Usage
-----------------

.. code-block:: cpp

   #include <featherdoc.hpp>

   int main() {
       featherdoc::Document doc{"input.docx"};
       if (doc.open()) {
           return 1;
       }

       doc.paragraphs().add_run("Generated by FeatherDoc");
       return doc.save_as("output.docx") ? 1 : 0;
   }

Where To Go Next
----------------

* Use :doc:`api/document` for open/save, sections, headers, footers,
  inspection, and document-wide editing.
* Use :doc:`word_document_workflow` when you want a task-oriented path for
  generating, filling, reviewing, or batch-editing Word documents.
* Use :doc:`api/paragraph_run` for paragraphs and runs.
* Use :doc:`api/table` for tables, rows, and cells.
* Use :doc:`api/template_part` for bookmarks, content controls, template slots,
  and schema validation.
* Use :doc:`api/pdf_workflow` for experimental PDF import and export workflows.