Skip to content

Commit

Permalink
feat(main): add docs for rbuilder (#2)
Browse files Browse the repository at this point in the history
Signed-off-by: cuisongliu <cuisongliu@qq.com>
  • Loading branch information
cuisongliu authored Dec 29, 2024
1 parent e56d8e8 commit 31667b8
Showing 1 changed file with 8 additions and 78 deletions.
86 changes: 8 additions & 78 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,11 @@
## 环境设置
## RBuild-Runtime

### 安装 Rust
This is a [runtime](https://github.com/labring-actions/runtime) library for the RBuild build system. It is used to build
and run RBuild projects.
The runtime is rootfs for sealos cluster image, and it is also used to build and run RBuild projects.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Runtime types

### 安装 VSCode 插件

- crates: Rust 包管理
- Even Better TOML: TOML 文件支持
- Better Comments: 优化注释显示
- Error Lens: 错误提示优化
- GitLens: Git 增强
- Github Copilot: 代码提示
- indent-rainbow: 缩进显示优化
- Prettier - Code formatter: 代码格式化
- REST client: REST API 调试
- rust-analyzer: Rust 语言支持
- Rust Test lens: Rust 测试支持
- Rust Test Explorer: Rust 测试概览
- TODO Highlight: TODO 高亮
- vscode-icons: 图标优化
- YAML: YAML 文件支持

### 安装 cargo generate

cargo generate 是一个用于生成项目模板的工具。它可以使用已有的 github repo 作为模版生成新的项目。

```bash
cargo install cargo-generate
```

在我们的课程中,新的项目会使用 `tyr-rust-bootcamp/template` 模版生成基本的代码:

```bash
cargo generate tyr-rust-bootcamp/template
```

### 安装 pre-commit

pre-commit 是一个代码检查工具,可以在提交代码前进行代码检查。

```bash
brew install pre-commit
```

安装成功后运行 `pre-commit install` 即可。

### 安装 Cargo deny

Cargo deny 是一个 Cargo 插件,可以用于检查依赖的安全性。

```bash
cargo install --locked cargo-deny
```

### 安装 typos

typos 是一个拼写检查工具。

```bash
cargo install typos-cli
```

### 安装 git cliff

git cliff 是一个生成 changelog 的工具。

```bash
cargo install git-cliff
```

### 安装 cargo nextest

cargo nextest 是一个 Rust 增强测试工具。

```bash
cargo install cargo-nextest --locked
```
1. containerd
2. docker
3. crio

0 comments on commit 31667b8

Please # to comment.