Septembers
V2EX  ›  问与答

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

  •  
  •   Septembers · May 9, 2015 · 2284 views
    This topic created in 4051 days ago, the information mentioned may be changed or developed.
    7 replies    2015-05-09 19:15:14 +08:00
    pupboss
        1
    pupboss  
       May 9, 2015
    一定记得加 license😂不然你下个问题标题就是 《如何看待有人原封不动抄我源码?》
    adjusted
        2
    adjusted  
       May 9, 2015
    LICENSE可以放到repo里面
    tencoldays
        3
    tencoldays  
       May 9, 2015   ❤️ 1
    lincanbin
        4
    lincanbin  
       May 9, 2015   ❤️ 1
    简介(Features)
    如果是GUI相关一般还有带上一些Screenshot

    环境要求(Requirements)


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

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


    协议(License)
    lincanbin
        5
    lincanbin  
       May 9, 2015
    https://github.com/lincanbin/Carbon-Forum

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

    顺便发两个我自己写的ReadMe,前者是一个整站,后者是一个库。
    hoogle
        6
    hoogle  
       May 9, 2015 via iPhone
    还有 CI status 什么的
    KexyBiscuit
        7
    KexyBiscuit  
       May 9, 2015 via Android
    How to compile, 对新手很重要……好吧我是新手。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   5342 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 47ms · UTC 09:03 · PVG 17:03 · LAX 02:03 · JFK 05:03
    ♥ Do have faith in what you're doing.