大家项目的 README 习惯放中文还是英文?

2023-08-31 13:29:56 +08:00
 EatMi

起因是写了一个开源的项目: https://github.com/wy-luke/StableDiffusion-Installer-For-Mac (原谅我打了个广告)

在里面写了两份 README ,中文和英文的,纠结了好久,是中文放在首页还是英文放在首页

会考虑很多因素

一方面,这里毕竟是英文为主的社区嘛,作为程序员大家应该都理解,这个应该就不用多解释了

另一方面,觉得自己作为中国人,用母语无可厚非,也能宣扬一下我们国家,同时也是怕被喷,我见过不止一次有人喷,作为中国人但是 README 放的却是英文这件事了

我最终把英文放在首页是因为,看到阿里的一些仓库采用的也是英文,最终一狠心用了英文

我确实是自己想的多,也知道不用太在意别人的看法,自己的项目想怎样就怎样

这里我们不去说哪个对、哪个错,无论哪种都有一定的道理,只是想和大家理性地探讨一下,看看大家更倾向于哪种方式,出于好奇,也出于寻求解决方案

可能有人没有做过相关工作哈,那就假设,如果你有一个开源项目,你会怎么选择,为什么?

想做一个简单的投票,分别在 1 楼和 2 楼回复两个选项,如果你更倾向于某种方式,可以为其加个感谢

(感觉有点像骗感谢来了。。。)

6958 次点击
所在节点    程序员
101 条回复
janus77
2023-08-31 14:07:10 +08:00
我同意按主要受众为标准的办法
如果你不确定谁是主要的,看看你的宣传阵地,你如果在中文社区宣传多,引流来的中文用户就多,issue 里面提中文的也多。
lifesimple
2023-08-31 14:07:27 +08:00
README_CN.md
README_EN.md
README.md 里放上面两链接 中文文档 | English
不就完美了 不偏不倚
EatMi
2023-08-31 14:13:47 +08:00
@lifesimple #22 鬼才
villivateur
2023-08-31 14:21:52 +08:00
@lifesimple 这还是有偏有倚的,凭什么中文文档在左,英文在右[/狗头]
EatMi
2023-08-31 14:24:59 +08:00
@villivateur #24 鬼中鬼才
cwcc
2023-08-31 14:27:26 +08:00
我的有些项目完全面向中国人的就是直接中文 README.md ,但也有部分项目因为一开始面向中国人,后来也可以面向国际化,我就随缘了,但一份 1:1 的英文 README 我肯定是会写的,但也不保证首页 README.md 一定要英文。如果有人提意见,我就改,不提就这样了,哈哈。
skiy
2023-08-31 14:29:25 +08:00
我见过小程序的 README 用英文的。
笑不活了。老外的软件有小程序的吗?或者说有外包开发小程序开发给老外的吗?
duzhuo
2023-08-31 14:36:31 +08:00
见人说人话 见鬼说鬼话
WillBeethoven
2023-08-31 14:39:16 +08:00
默认英文,只面向中文网站/内容的项目才用中文。
EatMi
2023-08-31 14:46:47 +08:00
@skiy #27 其实也可以理解,一方面可能作者是出于练习目的,尝试使用英文 README ,另一方面,我们不得不承认,有时候英文就会显得更“专业”😂
callmesmc
2023-08-31 15:34:59 +08:00
我也见过喷别人 readme 不用中文的,感觉好奇葩,为什么默认作者和其他用户都是中国人
kwanzaa
2023-08-31 15:54:50 +08:00
见人说人话,见鬼说鬼话。
要不就默认 En ,给个 Zh 的超链。
Pencillll
2023-08-31 16:03:21 +08:00
用英文一劳永逸,老外和大部分国人都能看懂
以前还会额外提供中文版,现在不打算提供了,本来写文档就又费劲又无聊,维护两份文档直接超级加倍,还要考虑是否同步的问题,不如把精力省下来多写点代码
Lockeysama
2023-08-31 16:05:41 +08:00
本来想房中文的,后来放了英文,因为之前写了 Python 的 SDK ,因为 setup.py 里面引用了中文 readme ,导致在 Windows 下安装 SDK 一直编码报错。后来就索性直接用英文了。
qquantt
2023-08-31 16:07:08 +08:00
不用局限在 README
我和我妈只说村里话,和中小学同学基本说县里话,会中文的朋友我就说中文,以上都不会就英文,英文还不行就找个翻译机器。
tool2d
2023-08-31 16:08:19 +08:00
这就和软件是否需要出多语言版本一个道理,有人看还是需要的,毕竟有需求在。

有 gpt 帮助,翻译一般来说不是太大的问题,比以前没有的时候,要省力多了。
flyqie
2023-08-31 16:13:16 +08:00
default eng
jadelike
2023-08-31 16:14:16 +08:00
中文,因为我看不懂英文
fredweili
2023-08-31 16:38:05 +08:00
github 上不写英文,就是想内卷
TianHeiLeKuaiPao
2023-08-31 16:45:22 +08:00
预测又是一个撕逼贴

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/969742

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX