V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
Septembers
V2EX  ›  问与答

一个合格的开源项目 README 应该怎么写?

  •  
  •   Septembers · 2015-05-09 10:35:21 +08:00 · 1871 次点击
    这是一个创建于 3484 天前的主题,其中的信息可能已经有所发展或是发生改变。
    7 条回复    2015-05-09 19:15:14 +08:00
    pupboss
        1
    pupboss  
       2015-05-09 10:39:40 +08:00
    一定记得加 license😂不然你下个问题标题就是 《如何看待有人原封不动抄我源码?》
    adjusted
        2
    adjusted  
       2015-05-09 10:40:39 +08:00
    LICENSE可以放到repo里面
    tencoldays
        3
    tencoldays  
       2015-05-09 10:44:36 +08:00   ❤️ 1
    lincanbin
        4
    lincanbin  
       2015-05-09 10:48:45 +08:00   ❤️ 1
    简介(Features)
    如果是GUI相关一般还有带上一些Screenshot

    环境要求(Requirements)


    安装/部署(Installation)
    一般整站开源会带有部署说明。

    使用(Usage)
    如果是一个开源库,一般来说除了仓库里的Demo外,ReadMe中还会有一段实例代码。


    协议(License)
    lincanbin
        5
    lincanbin  
       2015-05-09 11:03:18 +08:00
    https://github.com/lincanbin/Carbon-Forum

    https://github.com/lincanbin/Material-Design-Avatars

    顺便发两个我自己写的ReadMe,前者是一个整站,后者是一个库。
    hoogle
        6
    hoogle  
       2015-05-09 11:19:55 +08:00 via iPhone
    还有 CI status 什么的
    KexyBiscuit
        7
    KexyBiscuit  
       2015-05-09 19:15:14 +08:00 via Android
    How to compile, 对新手很重要……好吧我是新手。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3418 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 00:08 · PVG 08:08 · LAX 16:08 · JFK 19:08
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.