Update README.md

main
piuplj8o5 2 months ago
parent bd3de64b54
commit e9115f9c7b

@ -1,2 +1,42 @@
# git
# 网络工程专业学期实验仓库
> 本仓库基于Git版本控制用于规范管理2025-2026学年第二学期 网络工程专业 课程实验的所有内容,包含源代码、实验报告、测试用例等。
---
## 🎯 项目目标 (What)
1. **系统化管理实验内容**:统一存放本学期所有课程实验的源代码、实验报告、测试脚本,避免文件混乱
2. **规范版本控制流程**通过Git记录每一次修改实现实验内容的可追溯、可回溯、可复现
3. **符合课程作业要求**:完成头歌分组作业的项目搭建,满足目录结构、文档规范等要求
4. **养成良好开发习惯**:遵循行业标准的项目结构与文档规范,为后续专业学习和实习做准备
---
## 💡 设计思路 (Why)
本项目采用业界通用的开源项目标准目录结构,设计思路如下:
1. **目录分离,职责清晰**
- `/src`:仅存放实验源代码,实现代码与文档的完全分离,便于维护
- `/docs`:仅存放实验报告、项目文档,方便老师查阅和自己复习
- `/tests`:仅存放测试脚本和测试数据,保证代码的可验证性
2. **README.md作为项目入口**
- 作为仓库的「门面」,提供项目全貌说明,让阅读者快速了解项目用途、结构和使用方法
- 包含项目目标、设计思路、实现方式、版本历史等核心内容,完全满足课程作业要求
3. **遵循Git标准流程**
- 采用「本地开发 → 暂存 → 提交 → 推送」的标准Git流程保证版本管理的规范性
---
## 🛠️ 实现方式 (How)
### 1. 技术栈与工具
- 版本控制工具Git
- 远程仓库平台:头歌实践教学平台
- 文档编写Markdown语法
- 代码编辑器Visual Studio Code / 头歌在线编辑器
### 2. 目录结构说明
```text
项目根目录/
├── src/ # 源代码目录存放各实验的核心代码如C/Java/Python/网络编程代码等)
├── docs/ # 文档目录存放实验报告report1.md等、项目设计文档、使用手册
├── tests/ # 测试目录:存放测试脚本、测试数据、用例验证文件
└── README.md # 项目说明文件:本文档,提供项目完整说明

Loading…
Cancel
Save