Skip to content

Commit 5f1dcf0

Browse files
committed
chore: doc
1 parent 28f0883 commit 5f1dcf0

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ With multi languages support:
2727

2828
![](./doc/sample-chi.png)
2929

30+
Or different render engine:
31+
32+
![](./doc/sample-remark.png)
33+
3034
## Usage
3135

3236
You can download prebuild binaries from [release page](https://github.com/williamfzc/chat-gpt-ppt/releases).
@@ -36,10 +40,32 @@ You can download prebuild binaries from [release page](https://github.com/willia
3640
3. Add your token to `token.txt`
3741
4. run `./cgp`
3842

39-
Everything done.
43+
Everything done. You can get some help about command line arguments with `cgp --help`.
44+
45+
```bash
46+
$ ./cgp_macos --help
47+
Usage of ./cgp_macos:
48+
-client string
49+
gpt client type (default "GPT35")
50+
-output string
51+
out path (default "./output.html")
52+
-renderer string
53+
renderer type (default "REMARK")
54+
-rendererBin string
55+
binary file for renderer
56+
-token string
57+
token file path (default "./token.txt")
58+
-topic string
59+
topic file path (default "./topic.txt")
60+
```
4061

4162
## Contribution
4263

64+
This project consists of two pluggable parts:
65+
66+
- Client: Send topics to GPT and get their responses
67+
- Renderer: Build slides from these pairs
68+
4369
Feel free to send us PR/issues.
4470

4571
## Changelog

doc/sample-remark.png

130 KB
Loading

0 commit comments

Comments
 (0)