Skip to content

Commit 40592fd

Browse files
committed
docs: update README with screenshot and project description
Replace the template README with a Chinese-language overview including a screenshot, feature list, dev commands, and dependencies.
1 parent dac28de commit 40592fd

2 files changed

Lines changed: 27 additions & 8 deletions

File tree

.github/app_home.png

419 KB
Loading

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
1-
# mini-excel
1+
![screenshot](.github/app_home.png)
22

3-
This is a [Ratatui] app generated by the [Hello World template].
3+
`miniExcel` 是一个基于 [Ratatui](https://ratatui.rs) 的终端表格应用。它提供类似电子表格的基础编辑体验,适合在终端里快速创建、打开和维护 `.mxlsx` 工作簿文件。
44

5-
[Ratatui]: https://ratatui.rs
6-
[Hello World Template]: https://github.com/ratatui/templates/tree/main/hello-world
5+
> 额,目前只是一个玩具,用于应付课设。
76
8-
## License
7+
## 功能
98

10-
Copyright (c) uednd <247128190+uednd@users.noreply.github.com>
9+
- 键盘驱动的表格编辑
10+
- 多单元格选中、复制和粘贴
11+
- 部分公式解析
1112

12-
This project is licensed under the MIT license ([LICENSE] or <http://opensource.org/licenses/MIT>)
13+
## Development
1314

14-
[LICENSE]: ./LICENSE
15+
常用命令:
16+
17+
```bash
18+
cargo fmt --check
19+
cargo check
20+
cargo test
21+
```
22+
23+
项目依赖:
24+
25+
- `Ratatui`:终端 UI 框架
26+
- `crossterm`:终端事件与输入处理
27+
- `serde` / `serde_json`:工作簿和最近打开记录序列化
28+
- `pest`:公式解析
29+
- `arboard`:系统剪贴板
30+
31+
## 许可证
32+
33+
本项目使用 MIT License,详见 [LICENSE](LICENSE)

0 commit comments

Comments
 (0)