Skip to content

Commit ecac91c

Browse files
committed
更新网站
1 parent cdac196 commit ecac91c

File tree

2 files changed

+64
-2
lines changed

2 files changed

+64
-2
lines changed

website/docs/guide/installation.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: 快速开始
3+
---
4+
5+
# 快速开始
6+
7+
RMM 是一个使用 Rust 开发的命令行工具,用于初始化、构建、测试和发布 RMM 模块。
8+
9+
10+
## 使用 Python Pip 安装
11+
12+
安装 `pyrmm`
13+
14+
```bash
15+
pip install pyrmm
16+
```
17+
18+
然后可以使用:
19+
20+
```bash
21+
python -m pyrmm init <project_path>
22+
```
23+
24+
## uv 安装
25+
如果你使用 `uv` 可以通过以下命令安装:
26+
27+
```bash
28+
uv tool install pyrmm
29+
```
30+
31+
任何命令都可以通过以下方式查看帮助:
32+
33+
```bash
34+
rmm xxx --help
35+
```
36+
37+
## 从源代码安装
38+
39+
git clone RMM 源代码:
40+
41+
```bash
42+
git clone https://github.com/LIghtJUNction/RootManageModuleModel.git
43+
44+
cd RootManageModuleModel
45+
46+
然后你可以修改.python-version文件来指定 Python 版本。
47+
48+
uv sync # 使用该版本
49+
50+
maturin develop
51+
52+
uv build # 构建项目
53+
54+
uv tool install -e .
55+
&&
56+
uv tool install -e . --force
57+
58+
# 安装完成,然后使用 rmm即可启动
59+
rmm init <project_path>
60+
61+
62+
```

website/docs/guide/sync.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ title: 同步命令
1515
rmm sync
1616

1717
# 仅同步项目列表,不更新项目元数据
18-
rmm sync --projects-only
18+
rmm sync --projects
1919

2020
# 指定最大搜索深度为 2
2121
rmm sync --max-depth 2
2222
```
2323

2424
## 选项
2525

26-
- `--projects-only`:仅同步项目列表,跳过元数据更新。
26+
- `--projects`:仅同步项目列表,跳过元数据更新。
2727
- `--max-depth <N>`:搜索项目的最大目录深度。

0 commit comments

Comments
 (0)