Skip to content

Commit 6f53c50

Browse files
committed
Update README
1 parent eefc815 commit 6f53c50

File tree

2 files changed

+77
-6
lines changed

2 files changed

+77
-6
lines changed

README.en-US.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## todo-rs
2+
3+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/liruifengv/todo-rs)
4+
5+
English | [简体中文](./README.md)
6+
7+
A minimalist CLI todo list write by rust.
8+
9+
## Usage
10+
11+
```console
12+
~ rodo --help
13+
rodo 0.1.0
14+
Rodo is a simple todo list manager.
15+
16+
USAGE:
17+
rodo.exe <SUBCOMMAND>
18+
19+
OPTIONS:
20+
-h, --help Print help information
21+
-V, --version Print version information
22+
23+
SUBCOMMANDS:
24+
add Add a todo item.
25+
help Print this message or the help of the given subcommand(s)
26+
info Show rodo info.
27+
list List all the todo items. [aliases: ls, ll, la]
28+
remove Remove a todo item. [aliases: rm]
29+
```
30+
31+
## Development
32+
33+
```bash
34+
# clone the repo
35+
git clone
36+
37+
# run the program in local
38+
cargo run
39+
40+
# build the program
41+
cargo build
42+
```
43+
44+
## ISSUE
45+
46+
Please [contact me](https://github.com/liruifengv/todo-rs/issues) if you encounter any problems.
47+
48+
## Contributing
49+
50+
You can open a PR or issue to contribute to this project.
51+
52+
## License
53+
54+
todo-rs is released under the MIT License. See the bundled
55+
[LICENSE](./LICENSE) file for details.

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
## todo-rs
22

3-
A minimalist CLI todo list write by rust.
3+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/liruifengv/todo-rs)
44

5-
## Usage
5+
简体中文 | [English](./README.en-US.md)
6+
7+
Rust 开发的简易命令行 TODO LIST。
8+
9+
## 用法
610

711
```console
812
~ rodo --help
@@ -24,15 +28,27 @@ SUBCOMMANDS:
2428
remove Remove a todo item. [aliases: rm]
2529
```
2630

27-
## Development
31+
## 开发
2832

2933
```bash
30-
# clone the repo
34+
# 克隆这个仓库
3135
git clone
3236

33-
# run the program in local
37+
# 本地运行
3438
cargo run
3539

36-
# build the program
40+
# 打包
3741
cargo build
3842
```
43+
44+
## ISSUE
45+
46+
如果你遇到任何问题,欢迎[联系我](https://github.com/liruifengv/todo-rs/issues)
47+
48+
## Contributing
49+
50+
你可以随时给这个项目提 PR。
51+
52+
## License
53+
54+
todo-rs 基于 MIT 协议。查看 [LICENSE](./LICENSE) 详情。

0 commit comments

Comments
 (0)