mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-11-01 18:51:53 +08:00
Align all READMEs, AGENTS.md, CONTRIBUTING.md and dc3/doc/* with the new Makefile interface (SERVICES/GROUP selectors, REGISTRY=cn, podman default) and updated Dockerfile structure. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
IoT DC3 Documentation
This directory contains project-level documentation for local development, deployment, troubleshooting, and driver authoring.
| Document | Purpose |
|---|---|
| USAGE.md | Container image usage and registry options |
| QUICKSTART.md | Local source-code development workflow |
| MODULES.md | Maven module map and runtime flow |
| ENVIRONMENT.md | Environment variable usage and purpose |
| LOGGING.md | Application logging format and usage guidelines |
| DRIVER-AUTHORING.md | Guide for creating a new protocol driver |
| TROUBLESHOOTING.md | Common build and runtime issues |
| CHANGE.md | Release change notes |
| TITLE.md | Release title and short project introduction |
Unless stated otherwise, commands in these documents should be run from the repository root.