Bootstrap Neitzel FX Designer repository foundation

2026-11-12 07:18:59 +01:00
commit 953f01a19c
13 changed files with 855 additions and 0 deletions
@@ -0,0 +1,36 @@
+# Neitzel FX Designer
+
+Shared Scene Builder Kit designer for NeitzelLib FX, with planned standalone and IntelliJ hosts.
+
+## Current state
+
+This initial repository contains the accepted contracts, bootstrap plan, project instructions and a pinned Maven build foundation (`de.neitzel.fxdesigner:neitzel-fx-designer:0.1.0-SNAPSHOT`). It currently has **no application sources, implemented modules, runnable designer or packaged IntelliJ plugin**. The root POM validates the build environment; it does not yet build a UI. The module layout in the contract is planned work.
+
+The corrected NeitzelLib dependency is not yet pinned: its Component builder fix must be integrated separately and the first containing release verified. NeitzelLib sources and prototype implementations are not copied here.
+
+## Validate the foundation
+
+Requirements: JDK 21 or newer, Python 3.10 or newer, and network access on the first Maven/dependency download. Select the intended JDK through `JAVA_HOME`.
+
+```sh
+python3 scripts/check-bootstrap.py
+```
+
+This runs Maven's clean/verify lifecycle through the pinned wrapper and validates local documentation links and illustrative JSON. Maven is pinned to **3.9.11** using Apache Maven Wrapper **3.3.4**. No system Maven installation is needed for this command. On Windows the check invokes `mvnw.cmd`; validation has initially been performed on macOS only.
+
+For just the Maven foundation:
+
+```sh
+./mvnw --batch-mode --no-transfer-progress clean verify
+```
+
+The JDK requirement above is for the bootstrap, not a declaration that all future modules or JavaFX 26 hosts run on Java 21. Target/host and bytecode baselines are established independently in the implementation plan.
+
+## Implementation references
+
+- [Initial project contract](docs/initial-project-contract.md): module responsibilities, configuration, snapshots, runtimes, preview sessions and communication.
+- [Repository bootstrap plan](docs/repository-bootstrap-plan.md): ordered work packages and acceptance gates. Next: isolate and validate the NeitzelLib runtime fix, then implement module/host boundaries.
+- [Decision provenance](docs/provenance.md): workspace planning and captured prototype evidence.
+- [Third-party notices](THIRD-PARTY-NOTICES.md): Maven wrapper provenance.
+
+The canonical checkout is `/Volumes/PlanckSSD/KI/java/NeitzelFXDesigner`. Its Git remote is `ssh://git@gitea.neitzel.de:2222/konrad/NeitzelFXDesigner.git` and its default branch is `main`.