Skip to content

Commit cd141e7

Browse files
committed
doc: update README
1 parent 7b63a39 commit cd141e7

File tree

1 file changed

+1
-87
lines changed

1 file changed

+1
-87
lines changed

README.md

Lines changed: 1 addition & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1 @@
1-
# Rust 项目统一框架
2-
3-
> 本框架基于陈天老师的 [tyr-rust-bootcamp/template](https://github.com/tyr-rust-bootcamp/template),做了简单的修改。
4-
5-
## 环境设置
6-
7-
### 安装 Rust
8-
9-
```bash
10-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
11-
```
12-
13-
### 安装 VSCode 插件
14-
15-
> 可以直接搜索 hedon-rust-pack 里面打包了 Rust 开发中常用的插件。
16-
17-
- crates: Rust 包管理
18-
- Even Better TOML: TOML 文件支持
19-
- Better Comments: 优化注释显示
20-
- Error Lens: 错误提示优化
21-
- GitLens: Git 增强
22-
- Github Copilot: 代码提示
23-
- indent-rainbow: 缩进显示优化
24-
- Prettier - Code formatter: 代码格式化
25-
- REST client: REST API 调试
26-
- rust-analyzer: Rust 语言支持
27-
- Rust Test lens: Rust 测试支持
28-
- Rust Test Explorer: Rust 测试概览
29-
- TODO Highlight: TODO 高亮
30-
- vscode-icons: 图标优化
31-
- YAML: YAML 文件支持
32-
33-
### 安装 cargo generate
34-
35-
cargo generate 是一个用于生成项目模板的工具。它可以使用已有的 github repo 作为模版生成新的项目。
36-
37-
```bash
38-
cargo install cargo-generate
39-
```
40-
41-
使用 `hedon-rust-road/template` 模版生成基本的代码:
42-
43-
```bash
44-
cargo generate hedon-rust-road/template
45-
```
46-
47-
### 安装 pre-commit
48-
49-
pre-commit 是一个代码检查工具,可以在提交代码前进行代码检查。
50-
51-
```bash
52-
pipx install pre-commit
53-
```
54-
55-
安装成功后运行 `pre-commit install` 即可。
56-
57-
### 安装 Cargo deny
58-
59-
Cargo deny 是一个 Cargo 插件,可以用于检查依赖的安全性。
60-
61-
```bash
62-
cargo install --locked cargo-deny
63-
```
64-
65-
### 安装 typos
66-
67-
typos 是一个拼写检查工具。
68-
69-
```bash
70-
cargo install typos-cli
71-
```
72-
73-
### 安装 git cliff
74-
75-
git cliff 是一个生成 changelog 的工具。
76-
77-
```bash
78-
cargo install git-cliff
79-
```
80-
81-
### 安装 cargo nextest
82-
83-
cargo nextest 是一个 Rust 增强测试工具。
84-
85-
```bash
86-
cargo install cargo-nextest --locked
87-
```
1+
# CRM

0 commit comments

Comments
 (0)