diff --git a/README.md b/README.md index 6060f4e4f1ee0498183ba5be1535a51e0b092fb6..e91d06316ecb13b429aaab5d8d6f3953d2a6fe0f 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,54 @@ -# 数据结构与算法 - -#### 介绍 -记录学习数据结构的过程 - -#### 软件架构 -软件架构说明 - - -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx -#### 使用说明 -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 +# 数据结构与算法 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 介绍 +本项目是一个关于数据结构与算法的示例集合,旨在帮助开发者学习和理解常见的数据结构实现以及算法的使用方法。适用于对Go语言有一定基础的开发者。 + +## 软件架构 +项目按照不同的数据结构和算法分为多个目录,每个目录下包含具体的实现代码及可能的测试文件。主要包括: +- 链表(单向链表和双向链表) +- 队列(数组实现和链表实现) +- 栈(链表实现) +- 排序算法(冒泡排序、插入排序、快速排序、选择排序、希尔排序) +- 时间复杂度演示 +- 递归示例 + +## 安装教程 +1. 确保已经安装了 Go 环境(1.16 或更高版本)。 +2. 将项目克隆到本地: + ```bash + git clone https://gitee.com/yourusername/yourproject.git + ``` +3. 进入项目目录: + ```bash + cd yourproject + ``` + +## 使用说明 +每个 `demo` 子目录包含一个或多个 `.go` 文件,其中: +- `main.go` 通常包含示例的入口函数。 +- `_test.go` 文件包含单元测试,可以运行测试来验证功能。 + +运行单个程序: +```bash +go run demo/liinkedlist/single_linked_list.go +``` + +运行测试: +```bash +go test demo/liinkedlist/double_linked_list_test.go +``` + +## 参与贡献 +欢迎贡献代码和文档。请遵循以下步骤: +1. Fork 本仓库。 +2. 创建新分支。 +3. 提交代码修改。 +4. 创建 Pull Request。 + +## 特技 +本项目使用 Go 语言展示了多种数据结构的实现方式,包括链表、队列、栈和排序算法,并通过测试代码验证其正确性。 + +## 协议 +本项目遵循 MIT 协议。详情请参见 LICENSE 文件。 \ No newline at end of file