libjdk · yeaya · Oct 18, 2025 · Oct 18, 2025
diff --git a/README.en.md b/README.en.md
@@ -0,0 +1,124 @@
+# libjdk · java.desktop (C++)
+
+libjdk is a collection of JDK components implemented in C++. This repository corresponds to the `java.desktop` module (version 17.35). It covers AWT/Swing, Image I/O, printing, and other desktop capabilities. The current implementation focuses primarily on Windows.
+
+## Highlights
+- AWT/Swing components and related subsystems (`java.awt.*`, `javax.swing.*`, `sun.awt.*`, `sun.swing.*`, etc.)
+- Image processing and codecs (`javax.imageio.*` with BMP/JPEG/TIFF plugins)
+- Printing services (`javax.print.*`)
+- Sound/media related bridges (`javax.sound.*`)
+
+Note: The source layout follows the JDK package structure, while the implementation is in C++ and built via CMake into static/shared libraries.
+
+## Repository layout
+```
+├─ CMakeLists.txt           # Top-level build script, project and common options
+├─ LICENSE                  # Project license
+├─ legal/                   # Notices of third-party dependencies
+├─ main/
+│  ├─ CMakeLists.txt        # Core build logic for java.desktop
+│  └─ windows/
+│     ├─ classes/           # Windows-specific "classes" (organized by package)
+│     └─ native/            # Windows-specific native implementations (AWT/2D/font, etc.)
+└─ test/
+   ├─ CMakeLists.txt        # Test executable and test registrations
+   └─ windows/              # Windows test cases
+```
+
+## Prerequisites
+- CMake ≥ 3.12
+- C++17 compiler
+  - Windows: MSVC (Visual Studio 2019/2022)
+  - Linux/macOS: GCC or Clang (Windows is the primary target; other platforms are limited)
+- JCPP repository dependencies (to link other modules, all at version 17.35)
+  - Runtime deps: `java.base`, `java.xml`, `java.datatransfer`, `java.prefs`
+  - Extra for tests: `jdk.httpserver`, `java.logging`, etc.
+- Environment variables (to locate deps and install path)
+  - `JCPP_REPOSITORY_ROOT`: preferred; falls back to `{JCPP_HOME}/repository` if unset
+  - `JCPP_HOME`: used to derive default repository root
+
+## Build
+It’s recommended to build out-of-source.
+
+Windows (x64, Release, shared lib and tests enabled):
+```bash
+cmake -S . -B build ^
+  -G "Visual Studio 17 2022" -A x64 ^
+  -DBUILD_SHARED_LIB=ON -DBUILD_TEST=ON ^
+  -DJCPP_REPOSITORY_ROOT="C:/path/to/jcpp/repository"
+
+cmake --build build --config Release --parallel
+```
+
+Linux/macOS (Windows is the primary implementation; turn off tests if needed):
+```bash
+cmake -S . -B build \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DBUILD_SHARED_LIB=ON \
+  -DBUILD_TEST=OFF
+
+cmake --build build -j
+```
+
+Artifacts (examples):
+- Shared library: `java.desktop` (Windows: `java.desktop.dll`, Linux: `libjava.desktop.so`)
+- Static library: when `BUILD_STATIC_LIB` is enabled
+- Test executable: `java.desktop-test`
+
+## Run tests
+A large number of AWT/Swing tests are registered on Windows:
+```bash
+# On Windows
+ctest --test-dir build --output-on-failure -C Release
+```
+
+You can also run the produced `java.desktop-test` executable directly from the build directory.
+
+## Install and package
+Without writing into JCPP repository layout (default):
+```bash
+cmake --install build --config Release --prefix dist
+# dist/include, dist/lib, dist/bin
+```
+
+Install into JCPP repository (enable INSTALL_TO_REPO):
+```bash
+cmake -S . -B build -DINSTALL_TO_REPO=ON
+cmake --build build --config Release
+cmake --install build --config Release
+# Will install under:
+#   {JCPP_REPOSITORY_ROOT}/java.desktop/17.35/
+```
+
+Package with CPack:
+```bash
+# ZIP on Windows, TGZ on Linux/macOS
+cpack -C Release -B build
+```
+
+## Key CMake options
+- `BUILD_SHARED_LIB`: build shared library (default ON)
+- `BUILD_STATIC_LIB`: build static library (enabled when `BUILD_SHARED_LIB` is OFF)
+- `BUILD_TEST`: build tests (default ON; consider OFF on non-Windows platforms)
+- `INSTALL_TO_REPO`: install into JCPP repository layout (default OFF)
+- `ENABLE_NC`: enable null-check related compiler definitions (default OFF)
+
+## Troubleshooting
+1. Missing dependency libraries (link errors)
+   - Ensure `JCPP_REPOSITORY_ROOT` (or `JCPP_HOME`) is set and required modules (e.g., `java.base:17.35`) exist in the repository layout.
+2. No tests/targets on non-Windows platforms
+   - The current implementation focuses on Windows; other platforms are incomplete. You can disable `BUILD_TEST` to validate the base build.
+3. Very slow builds or very large objects
+   - The project is large. Big object options are enabled for MSVC/GCC/Clang. Use parallel builds and a recent compiler.
+
+## License and third-party components
+- Project license: see `LICENSE`
+- Third-party notices in `legal/` (e.g., freetype, harfbuzz, giflib, libpng, lcms)
+
+## Contributing
+Contributions are welcome. Before submitting changes please ensure:
+- You can configure and build locally
+- Changes pass existing tests (when applicable)
+- New/changed modules include appropriate docs and tests
+
+— Happy hacking!
diff --git a/README.md b/README.md
@@ -1,3 +1,124 @@
-# Welcome to the libjdk!
+# libjdk · java.desktop (C++)
 
-libjdk is a C++ version JDK.
+libjdk 是一个用 C++ 实现的 JDK 组件集合，本仓库对应 JDK 的 `java.desktop` 模块（版本 17.35）。该模块涵盖 AWT/Swing、Image I/O、打印等桌面相关能力，目前主要实现集中在 Windows 平台。
+
+## 功能概览
+- AWT/Swing 组件与相关子系统（`java.awt.*`, `javax.swing.*`, `sun.awt.*`, `sun.swing.*` 等）
+- 图像处理与编解码（`javax.imageio.*`，含 BMP/JPEG/TIFF 等插件）
+- 打印服务（`javax.print.*`）
+- 声音/媒体相关桥接（`javax.sound.*`）
+
+提示：源码组织与模块名沿用 JDK 包结构，但实现语言为 C++，通过 CMake 构建为可复用的静态/动态库。
+
+## 目录结构
+```
+├─ CMakeLists.txt           # 顶层构建脚本，定义项目与通用选项
+├─ LICENSE                  # 项目许可证
+├─ legal/                   # 第三方依赖的授权与声明
+├─ main/
+│  ├─ CMakeLists.txt        # java.desktop 主库构建逻辑
+│  └─ windows/
+│     ├─ classes/           # Windows 平台的“类”实现（按照包结构组织）
+│     └─ native/            # Windows 平台的原生实现（如 AWT/2D/字体 等）
+└─ test/
+   ├─ CMakeLists.txt        # 测试可执行程序与用例注册
+   └─ windows/              # Windows 平台测试用例
+```
+
+## 先决条件
+- CMake ≥ 3.12
+- C++17 编译器
+  - Windows: MSVC (Visual Studio 2019/2022)
+  - Linux/macOS: GCC 或 Clang（当前实现以 Windows 为主，其他平台构建目标有限）
+- JCPP 仓库依赖（用于链接其它模块，版本均为 17.35）
+  - 运行库依赖：`java.base`, `java.xml`, `java.datatransfer`, `java.prefs`
+  - 测试额外依赖：`jdk.httpserver`, `java.logging` 等
+- 环境变量（用于定位依赖与安装路径）
+  - `JCPP_REPOSITORY_ROOT`：优先使用；若未设置则回退到 `JCPP_HOME/repository`
+  - `JCPP_HOME`：未显式设置仓库根时用于推导
+
+## 构建
+建议在独立的构建目录中进行：
+
+Windows（x64，Release，构建共享库并启用测试）：
+```bash
+cmake -S . -B build ^
+  -G "Visual Studio 17 2022" -A x64 ^
+  -DBUILD_SHARED_LIB=ON -DBUILD_TEST=ON ^
+  -DJCPP_REPOSITORY_ROOT="C:/path/to/jcpp/repository"
+
+cmake --build build --config Release --parallel
+```
+
+Linux/macOS（当前实现以 Windows 为主，如需验证可关闭测试）：
+```bash
+cmake -S . -B build \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DBUILD_SHARED_LIB=ON \
+  -DBUILD_TEST=OFF
+
+cmake --build build -j
+```
+
+构建产物（示例）：
+- 动态库：`java.desktop`（Windows: `java.desktop.dll`，Linux: `libjava.desktop.so`）
+- 静态库：启用 `BUILD_STATIC_LIB` 时生成 `java.desktop` 静态库
+- 测试可执行文件：`java.desktop-test`
+
+## 运行测试
+仅在 Windows 环境会注册大量 AWT/Swing 相关用例：
+```bash
+# 在 Windows 上
+ctest --test-dir build --output-on-failure -C Release
+```
+
+也可以直接运行生成的 `java.desktop-test` 可执行文件（位于构建目录）。
+
+## 安装与打包
+不写入 JCPP 仓库（默认）：
+```bash
+cmake --install build --config Release --prefix dist
+# dist/include, dist/lib, dist/bin
+```
+
+写入 JCPP 仓库（开启 INSTALL_TO_REPO）：
+```bash
+cmake -S . -B build -DINSTALL_TO_REPO=ON
+cmake --build build --config Release
+cmake --install build --config Release
+# 将安装至：
+#   {JCPP_REPOSITORY_ROOT}/java.desktop/17.35/
+```
+
+打包（CPack）：
+```bash
+# Windows 生成 ZIP，Linux/macOS 生成 TGZ
+cpack -C Release -B build
+```
+
+## 关键 CMake 选项
+- `BUILD_SHARED_LIB`：构建共享库（默认 ON）
+- `BUILD_STATIC_LIB`：构建静态库（当 `BUILD_SHARED_LIB` 为 OFF 时启用）
+- `BUILD_TEST`：构建测试（默认 ON；非 Windows 平台建议 OFF）
+- `INSTALL_TO_REPO`：安装至 JCPP 仓库布局（默认 OFF）
+- `ENABLE_NC`：启用空指针检查相关编译开关（默认 OFF）
+
+## 常见问题
+1. 找不到依赖库（链接失败）
+   - 请确认已设置 `JCPP_REPOSITORY_ROOT`（或 `JCPP_HOME`），且依赖模块（如 `java.base:17.35` 等）已按照仓库布局就绪。
+2. 非 Windows 平台没有测试用例/目标为空
+   - 目前实现以 Windows 为主，其他平台的源码与测试尚不完整；可关闭 `BUILD_TEST` 验证基础构建流程。
+3. 链接或编译非常慢/对象过大
+   - 工程体量较大，CMake 已针对 MSVC/GCC/Clang 启用大对象编译选项；建议使用多核并行与较新的编译器。
+
+## 许可证与第三方组件
+- 本项目许可证见根目录 `LICENSE`
+- 第三方依赖的授权信息位于 `legal/` 目录（如 freetype、harfbuzz、giflib、libpng、lcms 等）
+
+## 贡献
+欢迎提交 Issue 与 PR。请在变更前确保：
+- 能在本地完成配置/构建
+- 变更通过现有测试（如适用）
+- 对新增/变更的模块补充必要的说明与用例
+
+—— Happy hacking!