Code Monkey home page Code Monkey logo

readmesample's Introduction

ReadmeSample

本篇已经收录到 fetool['杂七杂八']

项目高大上的第一步就是 包装,所以来看看README的书写套路吧:)

每一项都不是必须,还请自行参考


示例的项目名称为: ZhuangDeYiShouHaoBi

Goal and Philosophy

“目标以及哲学”,一个标题瞬间就让项目的气质提升了八个档次。

What’s ZhuangDeYiShouHaoBi

来来来,我们来装个逼。

康忙昂,北鼻。

Why ZhuangDeYiShouHaoBi

自问自答,为毛会有这个项目。

假如有人问劳资,为什么能想到这个伟大的Idea ZhuangDeYiShouHaoBi ,劳资会告诉丫:“因为装逼”。

Requirements

描述下必要的前提条件。

比如:基于koa的项目,就需要 node >= 0.11.9

Installation

如何安装呢?当然越简单越好,体验至上。

Usage

北鼻,这个肿么使用呢?

How It Works

工作原理要不要分享下?如果较复杂还是算了吧,写这里显得不专业,来个 GitPage 提升下逼格。

Writing

肿么开始呢?给爷拉出来溜溜。

More

相关推荐来几发。最好是贴一些国内外 较高级的切实有用的 的地址,方便大家延伸阅读。

也更显得偶们专业嘛,最起码证明鸟劳资也是查了很多相关资料的。

Credits

介绍项目成员

Contribute

采纳的PR贡献者列表,假如真的能有可以加上这项:)

License

over


您可以通过以下方式联系到我:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.