Skip to content

Commit eb9eadd

Browse files
committed
docu: readme in zh
1 parent 45f48ee commit eb9eadd

File tree

2 files changed

+165
-3
lines changed

2 files changed

+165
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Integrating ChatGPT into your browser deeply, everything you need is here.
1212
[![release][release-image]][release-url]
1313
[![verfiy][verify-image]][verify-url]
1414

15+
English | [简体中文](README_ZH.md)
16+
1517
### Install
1618

1719
[![Chrome][Chrome-image]][Chrome-url]
@@ -24,10 +26,10 @@ Integrating ChatGPT into your browser deeply, everything you need is here.
2426
(Waiting for store review, [Firefox version][Firefox-url] is now available)
2527

2628
[Guide](https://github.com/josStorer/chatGPTBox/wiki/Guide) |
27-
[Preview](https://github.com/josStorer/chatGPTBox#Preview) |
29+
[Preview](#Preview) |
2830
[Development&Contributing][dev-url] |
2931
[Donation](https://www.buymeacoffee.com/josStorer) |
30-
[Credit](https://github.com/josStorer/chatGPTBox#Credit)
32+
[Credit](#Credit)
3133

3234
[Video Demonstration](https://www.youtube.com/watch?v=E1smDxJvTRs)
3335

@@ -55,7 +57,7 @@ Integrating ChatGPT into your browser deeply, everything you need is here.
5557

5658
[Firefox-image]: https://img.shields.io/badge/-Firefox-orange?logo=firefox-browser&logoColor=white
5759

58-
[Firefox-url]: https://addons.mozilla.org/zh-CN/firefox/addon/chatgptbox/
60+
[Firefox-url]: https://addons.mozilla.org/firefox/addon/chatgptbox/
5961

6062
[Safari-image]: https://img.shields.io/badge/-Safari-blue?logo=safari&logoColor=white
6163

README_ZH.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
<p align="center">
2+
<img src="./src/logo.png">
3+
</p>
4+
5+
<h1 align="center">ChatGPT Box</h1>
6+
7+
<div align="center">
8+
9+
将ChatGPT深度集成到浏览器中, 你所需要的一切均在于此
10+
11+
[![license][license-image]][license-url]
12+
[![release][release-image]][release-url]
13+
[![verfiy][verify-image]][verify-url]
14+
15+
[English](README.md) | 简体中文
16+
17+
### 安装链接
18+
19+
[![Chrome][Chrome-image]][Chrome-url]
20+
[![Edge][Edge-image]][Edge-url]
21+
[![Firefox][Firefox-image]][Firefox-url]
22+
[![Safari][Safari-image]][Safari-url]
23+
[![Android][Android-image]][Android-url]
24+
[![Github][Github-image]][Github-url]
25+
26+
(目前正在等待商店审核, [Firefox][Firefox-url]版本已过审)
27+
28+
[使用指南](https://github.com/josStorer/chatGPTBox/wiki/Guide) |
29+
[效果预览](#Preview) |
30+
[开发&贡献][dev-url] |
31+
[捐助](https://www.buymeacoffee.com/josStorer) |
32+
[鸣谢](#Credit)
33+
34+
[视频演示](https://www.bilibili.com/video/BV1524y1x7io)
35+
36+
[dev-url]: https://github.com/josStorer/chatGPTBox/wiki/Development&Contributing
37+
38+
[license-image]: http://img.shields.io/badge/license-MIT-blue.svg
39+
40+
[license-url]: https://github.com/josStorer/chatGPTBox/blob/master/LICENSE
41+
42+
[release-image]: https://img.shields.io/github/release/josStorer/chatGPTBox.svg
43+
44+
[release-url]: https://github.com/josStorer/chatGPTBox/releases/latest
45+
46+
[verify-image]: https://github.com/josStorer/chatGPTBox/workflows/verify-configs/badge.svg
47+
48+
[verify-url]: https://github.com/josStorer/chatGPTBox/actions/workflows/verify-configs.yml
49+
50+
[Chrome-image]: https://img.shields.io/badge/-Chrome-brightgreen?logo=google-chrome&logoColor=white
51+
52+
[Chrome-url]: https://github.com/josStorer/chatGPTBox/wiki/Install
53+
54+
[Edge-image]: https://img.shields.io/badge/-Edge-blue?logo=microsoft-edge&logoColor=white
55+
56+
[Edge-url]: https://github.com/josStorer/chatGPTBox/wiki/Install
57+
58+
[Firefox-image]: https://img.shields.io/badge/-Firefox-orange?logo=firefox-browser&logoColor=white
59+
60+
[Firefox-url]: https://addons.mozilla.org/firefox/addon/chatgptbox/
61+
62+
[Safari-image]: https://img.shields.io/badge/-Safari-blue?logo=safari&logoColor=white
63+
64+
[Safari-url]: https://github.com/josStorer/chatGPTBox/wiki/Install
65+
66+
[Android-image]: https://img.shields.io/badge/-Android-brightgreen?logo=android&logoColor=white
67+
68+
[Android-url]: https://github.com/josStorer/chatGPTBox/wiki/Install#install-to-android
69+
70+
[Github-image]: https://img.shields.io/badge/-Github-black?logo=github&logoColor=white
71+
72+
[Github-url]: https://github.com/josStorer/chatGPTBox/releases/latest
73+
74+
</div>
75+
76+
## ✨ Features
77+
78+
- 🌈 在任何页面随时呼出聊天对话框
79+
- 🔗 多种API支持 (免费用户和Plus用户可用Web API, 此外还有GPT-3, GPT-3.5等)
80+
- 📦 对各种常用网站的集成适配 (reddit, quora, youtube, github, gitlab, zhihu, bilibili)
81+
- 🔍 对所有主流搜索引擎的适配, 并支持自定义查询以支持额外的站点
82+
- 🧰 框选工具与右键菜单, 执行各种你的需求, 如翻译, 总结, 润色, 情感分析, 段落划分, 代码解释, 问询
83+
- 🗂️ 静态卡片支持浮出聊天框, 进行多分支对话
84+
- 🖨️ 随意保存你的完整对话记录, 或进行局部复制
85+
- 🎨 强大的渲染支持, 不论是代码高亮, 还是复杂数学公式
86+
- 🌍 多语言偏好支持
87+
- 📝 [自定义API地址](https://github.com/Ice-Hazymoon/openai-scf-proxy)支持
88+
- ⚙️ 所有站点适配与工具均可自由开关, 随时停用你不需要的模块
89+
- 💡 工具与站点适配开发易于扩展, 对于开发人员易于自定义, 请查看[开发&贡献][dev-url]部分
90+
- 😉 此外, 如果回答有任何不足, 直接聊天解决!
91+
92+
## Preview
93+
94+
<div align="center">
95+
96+
**搜索引擎适配, 浮动窗口, 对话分支**
97+
98+
![preview_google_floatingwindow_conversationbranch](screenshots/preview_google_floatingwindow_conversationbranch.jpg)
99+
100+
**常用站点集成, 选择浮动工具**
101+
102+
![preview_reddit_selectiontools](screenshots/preview_reddit_selectiontools.jpg)
103+
104+
**Git分析, 右键菜单**
105+
106+
![preview_github_rightclickmenu](screenshots/preview_github_rightclickmenu.jpg)
107+
108+
**视频总结**
109+
110+
![preview_youtube](screenshots/preview_youtube.jpg)
111+
112+
**移动端效果**
113+
114+
![image](https://user-images.githubusercontent.com/13366013/225529110-9221c8ce-ad41-423e-b6ec-097981e74b66.png)
115+
116+
**设置界面**
117+
118+
![preview_settings](screenshots/preview_settings.jpg)
119+
120+
</div>
121+
122+
## Credit
123+
124+
该项目基于我的另一个项目 [josStorer/chatGPT-search-engine-extension](https://github.com/josStorer/chatGPT-search-engine-extension)
125+
126+
[josStorer/chatGPT-search-engine-extension](https://github.com/josStorer/chatGPT-search-engine-extension)
127+
fork自 [wong2/chat-gpt-google-extension](https://github.com/wong2/chat-gpt-google-extension)(我从中学到很多)
128+
并在2022年12月14日与上游分离
129+
130+
[wong2/chat-gpt-google-extension](https://github.com/wong2/chat-gpt-google-extension) 的想法源于
131+
[ZohaibAhmed/ChatGPT-Google](https://github.com/ZohaibAhmed/ChatGPT-Google) ([upstream-c54528b](https://github.com/wong2/chatgpt-google-extension/commit/c54528b0e13058ab78bfb433c92603db017d1b6b))
132+
133+
### 额外声明
134+
135+
#### 这个声明主要针对可能的道德问题指责
136+
137+
该项目最终可追溯至chatGPT刚刚爆火时出现的一个明星项目 [wong2/chat-gpt-google-extension](https://github.com/wong2/chat-gpt-google-extension),
138+
一开始我为其添加了各种市面上主流搜索引擎的支持, 后续我也进一步改进了兼容性, 并提交了自动化构建支持等.
139+
起初我更倾向于贡献到原始项目, 你可以查看我的[PR记录](https://github.com/wong2/chatgpt-google-extension/pulls?q=is%3Apr+author%3AjosStorer+).
140+
我也在原始项目中的许多Issue中参与解决问题, 例如[该问题](https://github.com/wong2/chatgpt-google-extension/issues/110#issuecomment-1399831569)中,
141+
我提及了我解决Safari构建的方式, 在[该PR中](https://github.com/wong2/chatgpt-google-extension/pull/187), 我尝试解决挂载点的检测问题,
142+
又比如对于一些赤裸裸的[抄袭现象](https://github.com/wong2/chatgpt-google-extension/issues/197#issuecomment-1399824044), 我也深感不满.
143+
144+
但是, 在一些问题上, 我与原作者的理念不合, 例如像[Katex渲染](https://github.com/wong2/chatgpt-google-extension/pull/75)的支持, 原作者在持续要求发起者改进后,
145+
却又以体积问题为由拒绝了, 又比如[交互模式](https://github.com/wong2/chatgpt-google-extension/pull/103)的支持, 原作者同样拒绝了, 但是同时却一直把连续对话的Issue, Pin在顶部,
146+
又一直不提供任何支持, 直至被其他团队收购后, 由其他团队进行了实现,
147+
实际上早期我在贡献多搜索引擎支持时, 我认为这是个优先级比较高的功能, 但我觉得原作者推进有些缓慢, 而在执行一些我觉得优先级不高的事情, 并且其在合并搜索引擎支持后,
148+
又刻意删除了几个引擎的支持, 并发起了一个请求的讨论, 导致用户重新前去提出, 而直至项目被收购, 讨论被关闭的几个月时间里, 原项目接收到大量的请求, 却全部被忽视了,
149+
这意味着这个讨论一开始就是没有意义的, 我对诸如此类的做事风格深感不满.
150+
151+
而原项目中也有一些有创意的想法, 许多都早于现在的一些独立项目, 例如[视频总结](https://github.com/wong2/chatgpt-google-extension/issues/140)请求,
152+
很早就有人提出了, 但原作者同样拒绝了.
153+
154+
出于种种原因, 我决定与上游分离, 并独立维护各种功能更新, 一直以来, 我维护的分支都始终覆盖了原项目所有功能, 并一直提供大量的额外功能支持, 也就是这个项目的[前身](https://github.com/josStorer/chatGPT-search-engine-extension).
155+
但是, 我一直不愿意上架应用商店, 因为我认为这有违道德, 我不希望与原项目构成竞争.
156+
157+
直至2023年2月份, 原作者宣布项目被收购, 代码将闭源, 我最终决定将一些比较好的社区提出的Issue, 但是被原作者拒绝的, 进行整合, 并上架商店, 最终诞生了这个项目.
158+
159+
我仍想特别强调, 我只是对事不对人, 原作者是行业的前辈了, 而我只是个初出茅庐的菜鸡, 我不希望任何人因此对原作者进行任何攻击, 做开源的, 没有谁的时间是免费的,
160+
原作者并没有做错任何事, 并且他的项目启发了大量的社区独立项目, 我也从中学到了很多, 而原作者的成功变现, 及运营过程也是非常值得学习的, 我仍然对其贡献表示尊敬.

0 commit comments

Comments
 (0)