freepdfeditor/README.md

37 lines
1.5 KiB
Markdown

# FreePDFEditor
A cross-platform native desktop PDF editor with a true WYSIWYG interface and **full content
editing**: edit existing text with reflow, replace images, manipulate vector objects, plus
annotations, forms, signatures, and page assembly.
* **Stack:** C++20, Qt 6.7 (Widgets shell, custom canvas), CMake, vcpkg.
* **License:** GPL-3.0-or-later (see [`LICENSES/GPL-3.0-or-later.txt`](LICENSES/GPL-3.0-or-later.txt)).
Qt is dynamically linked under LGPL-3.0.
* **Targets:** Windows 10+, macOS 12+ (Intel + Apple Silicon), Linux (X11/Wayland).
This repository contains the source and build infrastructure. The full engineering plan and
roadmap live in [`docs/plan.md`](docs/plan.md); architecture decision records are under
[`docs/adr/`](docs/adr/).
## Status
Pre-M0. This is the initial repository scaffold described in §14 of the plan: CMake + vcpkg
skeleton, governance docs, CI matrix, packaging pipeline, an empty-window application shell, the
pixel-diff harness scaffolding, and the Spike A (QPDF verbatim round-trip) harness. The
feasibility spikes that gate the project run on top of this scaffolding.
## Building
```bash
cmake --preset default
cmake --build --preset default
ctest --preset default
```
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full build setup, gate matrix, and coding
standard.
## Source control
All code is developed on the project Gitea instance at `https://gitea.lm.je/ai-ad4/freepdfeditor`
per [`docs/plan.md`](docs/plan.md) §13. See `SECURITY.md` for vulnerability reporting.