Skip to content

Commit d40929f

Browse files
committed
doc: README.md
1 parent 06d0032 commit d40929f

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,47 @@
22

33
本项目是用于增强 LeetCode 体验的用户脚本(userscript)。它是使用 `bun` 创建的。Bun 是一个快速的、集成包管理、构建和运行的 JavaScript 运行时。
44

5-
## 环境要求
5+
## 功能介绍
66

7-
在开始之前,确保你的系统已安装 [Bun](https://bun.sh)。如果未安装,可以通过以下命令进行安装
7+
本项目提供以下功能来增强 LeetCode 编辑器体验
88

9-
```bash
10-
curl https://bun.sh/install | bash
11-
```
9+
- **代码补全**:支持 C++ 和 Java 语言的智能代码补全。
10+
- **模板插入**:常用的 C++ 和 Java 容器及算法模板补全,如 `vector`, `map`, `set` 等。
11+
- **方法提示**:标准库容器的方法提示,如 `push`, `pop`, `size` 等。
12+
- **扩展计划**:将会增加更多语言支持。
1213

13-
## 使用油猴 (Tampermonkey)
14+
## 使用方法
1415

1516
构建项目后,你可以将生成的代码复制到油猴(Tampermonkey)中使用。
1617

1718
在运行 bun run build 之后,进入项目的 dist 目录。你会看到一个打包好的 .js 文件。你也可以直接在Releases中下载已经打包的js文件,复制里面的内容到油猴插件中即可使用,
1819

1920
打开浏览器中的 Tampermonkey(油猴)扩展程序。
2021

21-
创建一个新脚本,然后将 dist 目录中的打包代码复制到新脚本中。
22+
## 开发环境
23+
24+
在开始之前,确保你的系统已安装 [Bun](https://bun.sh)。如果未安装,可以通过以下命令进行安装:
25+
26+
```bash
27+
curl https://bun.sh/install | bash
28+
```
29+
30+
## 构建项目
31+
32+
克隆本项目仓库。
33+
打开项目目录,在终端中运行以下命令来安装依赖:
2234

23-
保存脚本,脚本将在你浏览相关网站时自动运行。
35+
```bash
36+
bun install
37+
```
38+
运行以下命令来构建项目:
2439

40+
```bash
41+
bun run build
42+
```
2543
## 注意事项
44+
2645
确保每次修改代码后重新运行 bun run build 来生成新的打包文件。
46+
47+
---
2748
如果在使用过程中遇到问题,欢迎提交 Issue。

0 commit comments

Comments
 (0)