diff --git a/README.md b/README.md index 1516cebdf628ad4679b812ba3d7e1f77bbd8b9e4..f0a53dac670821c1c1b88906ddd2642fc2a3752b 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,42 @@ -# Java 数据结构与算法 - -本项目是一个基于 Java 实现的 **数据结构与算法** 示例库,旨在帮助开发者更好地理解常见数据结构与算法的实现原理。 - -## 📚 简介 - -本项目旨在提供清晰、规范的 Java 实现代码,涵盖常见的数据结构和算法。每个实现都包含详细的注释说明、单元测试。 - -> 每个实现都位于 `src/main/java/` 目录下,并在 `src/test/java/` 中包含完整的单元测试用例。 - -## 🛠️ 安装与使用 - -### 环境要求 -- JDK 8 -- Maven 3.9.3 - -### 安装步骤 -1. 克隆项目到本地: - -- gitee -```shell -git clone https://gitee.com/shenlink/data-structures-and-algorithms-java.git -cd data-structures-and-algorithms-java -``` - -- github -```shell -git clone https://github.com/shenlink/data-structures-and-algorithms-java.git -cd data-structures-and-algorithms-java -``` - -2. 下载依赖: -```shell -mvn dependency:resolve -``` - -## 🧪 测试 - -本项目使用 JUnit 4.13.1 编写单元测试,可以通过以下命令运行所有测试: - -```shell -mvn test -``` - -## 📄 许可证 - -本项目采用 [MIT 许可证](LICENSE) \ No newline at end of file +# Java 数据结构与算法 + +## 📚 简介 +该项目实现了基本的列表数据结构,包含一个抽象类 `AbstractList` 和具体实现类 `ArrayList`。它提供了常见的列表操作,如添加、删除、修改和查询元素,并处理了动态扩容和缩容。 + +## 🛠️ 安装与使用 + +### 环境要求 +- JDK 1.8 或更高版本 +- Maven + +### 安装步骤 +1. 克隆仓库到本地: + ```bash + git clone + ``` +2. 进入项目目录并构建: + ```bash + cd + mvn clean install + ``` + +## 🧪 测试 +该项目包含完整的单元测试,使用 JUnit 框架进行验证。测试覆盖了以下功能: +- 列表清空 (`clear`) +- 获取大小 (`size`) +- 判断是否为空 (`isEmpty`) +- 判断是否包含元素 (`contains`) +- 添加元素 (`add`) +- 获取元素 (`get`) +- 修改元素 (`set`) +- 在指定位置添加元素 (`add(int index, E element)`) +- 删除指定位置的元素 (`remove`) +- 获取元素索引 (`indexOf`) + +你可以通过以下命令运行测试: +```bash +mvn test +``` + +## 📄 许可证 +本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 \ No newline at end of file