V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
csznet2023
V2EX  ›  程序员

开源项目的英文版 readme 都是怎么写的

  •  
  •   csznet2023 · 261 天前 · 2147 次点击
    这是一个创建于 261 天前的主题,其中的信息可能已经有所发展或是发生改变。

    各位大佬的都是直接自己翻译的吗

    有没有自动化翻译的工具呢

    另外,默认 readme 我看很多都是默认英文,这有什么说法吗,我现在的都是默认中文的

    14 条回复    2024-03-20 08:21:24 +08:00
    sunorhc
        1
    sunorhc  
       261 天前
    想写英文的时候直接写,不用翻译。写不来的话现在直接让 gpt 翻译就行了。
    给中国人看就写中文,给外国人看就写英文呗。
    chenliangngng
        3
    chenliangngng  
       261 天前
    补个英文版,也不复杂好吗,都是一些专业词汇和套句,抄别家的换掉关键词就好了

    问题在于你真有必要整一份英文版吗
    foolishcrab
        4
    foolishcrab  
       261 天前 via iPhone   ❤️ 1
    @chenliangngng 正常技术类的项目英文自然流量都远大于中文,所以其实很有必要。当然 md 开源啥的就算了
    cnbatch
        5
    cnbatch  
       261 天前
    现在有 chatgpt ,翻译起来容易多了

    至于哪个语言用作主要语言,视乎受众而定,主要面对华人就用中文然后附近英文文档链接,要不然就英文文档附加中文版链接

    要是懂其他语言,比如日语、韩语,也可以一起写上
    yuezk
        6
    yuezk  
       261 天前   ❤️ 1
    找一个同类型的英文项目,模仿着写
    iGuo
        7
    iGuo  
       261 天前 via Android   ❤️ 1
    一般一句话或者几句话介绍核心功能,然后是安装方式,基本使用方式,完整文档,贡献者文档,开源协议,贡献者等等。多找朋友帮忙读读给点反馈,再根据需要修改即可。
    chaunceywe
        8
    chaunceywe  
       261 天前   ❤️ 1
    https://github.com/othneildrew/Best-README-Template 先用中文照着这个模版写一遍,然后再用 gpt 润色一遍。
    hauibojek
        9
    hauibojek  
       260 天前
    默认英文,然后加个中文文档链接。
    zhangjiashu2023
        10
    zhangjiashu2023  
       260 天前
    翻译首先 chatgpt
    zhangjiashu2023
        11
    zhangjiashu2023  
       260 天前
    翻译首选 chatgpt
    rookie2luochao
        12
    rookie2luochao  
       260 天前
    找一个热门开源项目,把它的 readme 拷贝过来抄着写🤔
    lstz
        13
    lstz  
       260 天前 via Android
    自动化翻译这个我特意自己造了个轮子,可以参考我的开源项目 LafTools ,翻译模板 devtools/docs-generator/files/*.md

    我用英语写,然后 bing translation 为 18 门语言翻译,当然这过程中还是需要微调的,我也写了一个配置文件去转换,基本维护成本很低。

    https://github.com/work7z/LafTools
    ben666
        14
    ben666  
       258 天前
    参考有一些知名的 github readme 模板项目,如 https://github.com/othneildrew/Best-README-Template
    也可以参考一下我的项目 https://github.com/baidu/dperf/ ,中英文 readme 都有
    尤其注意 license 标识 放在醒目的位置
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1164 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 23:04 · PVG 07:04 · LAX 15:04 · JFK 18:04
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.