25 lines
1.0 KiB
Markdown
25 lines
1.0 KiB
Markdown
|
角色设定：你是一位资深的 Java 架构师，擅长编写清晰、专业的项目文档。
|
|||
|
|
|
|||
|
|
任务目标：请深度扫描我提供的代码，并根据代码现状全面完善 README.md 文件。
|
|||
|
|
|
|||
|
|
扫描要求：
|
|||
|
|
|
|||
|
|
技术栈识别：自动识别并列出项目使用的 Java 版本、框架（如 Spring Boot）、构建工具（Maven/Gradle）及关键依赖。
|
|||
|
|
|
|||
|
|
核心模块说明：分析包结构，解释主要业务模块的功能。
|
|||
|
|
|
|||
|
|
配置说明：扫描 application.yml 或 properties 文件，提取关键配置项说明。
|
|||
|
|
|
|||
|
|
README 结构规范：
|
|||
|
|
|
|||
|
|
Project Title & Description: 简洁明了的项目名称和功能概述。
|
|||
|
|
|
|||
|
|
Tech Stack: 采用表格或列表形式展示。
|
|||
|
|
|
|||
|
|
Project Structure: 展示核心目录树并注释关键文件夹。
|
|||
|
|
|
|||
|
|
Getting Started: 包含环境要求、编译指令（如 ./mvnw clean install）和启动方式。
|
|||
|
|
|
|||
|
|
Key Features: 基于代码逻辑总结出的核心功能点。
|
|||
|
|
|
|||
|
|
执行指令：请先输出一份你观察到的项目概览，在我确认后，直接修改并覆盖当前的 README.md 文件
|