Update README and pyproject.toml

Author: muziing

README.md

@@ -1,65 +1,82 @@
 <h1 align="center">
-Automated driving algorithms
+自动驾驶算法
 </h1>
 <p align="center">
-Python codes for automated driving algorithms.
+自动驾驶相关算法代码仓库，Python 语言版。
 </p>
 <p align="center">
-English | <a href="README_zh.md">简体中文</a>
+简体中文 | <a href="README_en.md">English</a>
 </p>
 
-## How to use
+[![GitHub Repo stars](https://img.shields.io/github/stars/muziing/PythonAutomatedDriving)](https://github.com/muziing/PythonAutomatedDriving)
+![License](https://img.shields.io/github/license/muziing/PythonAutomatedDriving)
 
-### 1. Get source code
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/muziing/PythonAutomatedDriving/main.svg)](https://results.pre-commit.ci/latest/github/muziing/PythonAutomatedDriving/main)
 
-1. Add star to this repo if you like it :smiley:
-2. Get source code by one of the following methods
-    - [Download code zip](https://github.com/muziing/PythonAutomatedDriving/archive/refs/heads/main.zip)
-    - (For development only) clone repo `git clone https://github.com/muziing/PythonAutomatedDriving.git`
-3. Go to the project directory `cd /your/path/to/PythonAutomatedDriving`
+## 简介
 
-### 2. Creating Virtual Environment and Install requirements
+本代码仓库收录若干关于「自动驾驶-规划与控制算法」相关的代码，全部由 Python 语言实现。希望能为其他 PnC 算法学习者提供一批接口清晰统一、可直接复用的代码段，避免减少重复造轮子。
 
-**Option A**: venv & pip
+## 如何使用
 
-1. Ensure that the Python version matches the one required in [pyproject.toml](./pyproject.toml).
-2. Create virtual environment
+### 一、获取源码
+
+1. Star 本仓库 :smiley:
+2. 通过以下方式之一获取源码：
+    - 下载代码压缩包：<https://github.com/muziing/PythonAutomatedDriving/archive/refs/heads/main.zip>
+    - （仅需要参与开发时）克隆仓库 `git clone https://github.com/muziing/PythonAutomatedDriving.git`
+3. 进入项目目录 `cd /your/path/to/PythonAutomatedDriving`
+
+### 二、配置虚拟环境与安装依赖
+
+**方式 A**： venv 与 pip
+
+1. 确保 Python 版本与 [pyproject.toml](./pyproject.toml) 中要求的一致
+2. 创建虚拟环境
     - Windows: `python -m venv --upgrade-deps venv`
     - Linux/macOS: `python3 -m venv --upgrade-deps venv`
-3. Activate virtual environment
+3. 激活虚拟环境
     - Windows: `venv\Scripts\activate`
     - Linux/macOS: `. venv/bin/activate`
-4. Install the requirements `pip install -r requirements.txt`
+4. 安装依赖 `pip install -r requirements.txt`
+
+**方式 B**：[Poetry](https://python-poetry.org)
 
-**Option B**: [Poetry](https://python-poetry.org)
+1. 确保 Python 版本与 [pyproject.toml](./pyproject.toml) 中要求的一致
+2. 按[官方文档](https://python-poetry.org/docs/#installation)指示安装 Poetry
+3. 创建虚拟环境：`poetry env use /full/path/to/python`（注意替换路径，使用符合版本要求的解释器）
+4. 安装依赖：`poetry install --no-dev`
+5. 使用该虚拟环境： `poetry shell`（或在 PyCharm 等 IDE 中配置）
 
-1. Make sure the Python version is the same as required in [pyproject.toml](./pyproject.toml).
-2. Install Poetry as instructed in the [official documentation](https://python-poetry.org/docs/#installation).
-3. Create a virtual environment: `poetry env use /full/path/to/python`
-4. Install dependencies: `poetry install --no-dev`
-5. Use the virtual environment: `poetry shell` (or configure it in an IDE like PyCharm).
+**方式 C**：[Anaconda](https://www.anaconda.com/)
 
-**Option C**: [Anaconda](https://www.anaconda.com/)
+由于主要开发与测试工作仅在 Poetry 环境中进行，conda 环境可能出现意料之外的错误。请[提交 issue](https://github.com/muziing/PythonAutomatedDriving/issues) 帮助我发现和解决这些问题。
 
 ````shell
 conda env create -f environment.yml
 ````
 
-### 3. Run!
+### 三、运行！
 
-Execute Python script in each directory.
+在每个子项目目录中运行 Python 脚本。
 
-## Table of Contents
+## 目录
 
-### [AuxiliaryFunctions](AuxiliaryFunctions)
+### [utilities](src/utilities) 辅助函数
 
-- [curvature](AuxiliaryFunctions/curvature.py)  calculate curvature
+- [coordinate_transformation](src/utilities/coordinate_transformation.py) - 坐标变换
+- [discrete_curve_funcs](src/utilities/discrete_curve_funcs.py) - 处理二维离散曲线的函数
+- [numpy_additional_funcs](src/utilities/numpy_additional_funcs.py) - 一些补充numpy功能的自实现函数
 
-### [LocalPathPlanning](LocalPathPlanning)
+### [LocalPathPlanning](src/LocalPathPlanning) - 局部路径规划
 
-- [FSAE Path Planning](LocalPathPlanning/FSAE_PathPlanning)  适用于 FSAE 无人赛车高速循迹项目的路径规划算法
+- [FSAE Path Planning](src/LocalPathPlanning/FSAE_PathPlanning) - 一种适用于 FSAE 无人赛车高速循迹项目的路径规划算法
 
-## License
+## 许可协议
 
 ````text
 Copyright 2022-2023 muzing
@@ -68,7 +85,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+https://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

README_en.md

@@ -0,0 +1,86 @@
+<h1 align="center">
+Automated driving algorithms
+</h1>
+<p align="center">
+Python codes for automated driving algorithms.
+</p>
+<p align="center">
+<a href="README.md">简体中文</a> | English
+</p>
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/muziing/PythonAutomatedDriving)](https://github.com/muziing/PythonAutomatedDriving)
+![License](https://img.shields.io/github/license/muziing/PythonAutomatedDriving)
+
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+
+## How to use
+
+### 1. Get source code
+
+1. Add star to this repo if you like it :smiley:
+2. Get source code by one of the following methods
+    - [Download code zip](https://github.com/muziing/PythonAutomatedDriving/archive/refs/heads/main.zip)
+    - (For development only) clone repo `git clone https://github.com/muziing/PythonAutomatedDriving.git`
+3. Go to the project directory `cd /your/path/to/PythonAutomatedDriving`
+
+### 2. Creating Virtual Environment and Install requirements
+
+**Option A**: venv & pip
+
+1. Ensure that the Python version matches the one required in [pyproject.toml](./pyproject.toml).
+2. Create virtual environment
+    - Windows: `python -m venv --upgrade-deps venv`
+    - Linux/macOS: `python3 -m venv --upgrade-deps venv`
+3. Activate virtual environment
+    - Windows: `venv\Scripts\activate`
+    - Linux/macOS: `. venv/bin/activate`
+4. Install the requirements `pip install -r requirements.txt`
+
+**Option B**: [Poetry](https://python-poetry.org)
+
+1. Make sure the Python version is the same as required in [pyproject.toml](./pyproject.toml).
+2. Install Poetry as instructed in the [official documentation](https://python-poetry.org/docs/#installation).
+3. Create a virtual environment: `poetry env use /full/path/to/python`
+4. Install dependencies: `poetry install --no-dev`
+5. Use the virtual environment: `poetry shell` (or configure it in an IDE like PyCharm).
+
+**Option C**: [Anaconda](https://www.anaconda.com/)
+
+````shell
+conda env create -f environment.yml
+````
+
+### 3. Run!
+
+Execute Python script in each directory.
+
+## Table of Contents
+
+### [AuxiliaryFunctions](AuxiliaryFunctions)
+
+- [curvature](AuxiliaryFunctions/curvature.py)  calculate curvature
+
+### [LocalPathPlanning](LocalPathPlanning)
+
+- [FSAE Path Planning](LocalPathPlanning/FSAE_PathPlanning)  适用于 FSAE 无人赛车高速循迹项目的路径规划算法
+
+## License
+
+````text
+Copyright 2022-2023 muzing
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+````

README_zh.md

@@ -13,7 +13,7 @@ repository = "https://github.com/muziing/PythonAutomatedDriving"
 
 [tool.poetry.dependencies]
 python = ">=3.9,<3.12"
-numpy = "^1.24.0"
+numpy = "^1.25.0"
 scipy = "^1.11.0"
 matplotlib = "^3.7.0"
 jupyter = "^1.0.0"
@@ -44,6 +44,15 @@ target-version = ['py311']
 profile = "black"
 line_length = 88
 
+[tool.mypy]
+ignore_missing_imports = true
+check_untyped_defs = true
+
+[tool.ruff]
+# 目前版本的 Ruff 对中文字符支持不佳，对包含中文注释的代码会误认为过长，
+# 所以需要在配置文件中设置较大的行长度。真正的行长度控制由 Black 完成
+line-length = 130
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"