Skip to content

Instantly share code, notes, and snippets.

@paincompiler
Forked from PurpleBooth/README-Template.md
Last active August 29, 2017 06:34
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save paincompiler/70ff45df1db0fd0a940dbc107789b967 to your computer and use it in GitHub Desktop.
Save paincompiler/70ff45df1db0fd0a940dbc107789b967 to your computer and use it in GitHub Desktop.
A template to make good README.md

Project Title

One Paragraph of project description goes here

Summary

Describe what dose this project mainly do

Structure

├── action: xxxxxx

├── client: for tasuku RPC client

├── config: configuration for service

├── exchange: exchange data model layer

│   ├── model

│   └── proto: protocol for data exchange

├── exporter: handling data export

├── model: task related model ├── preview: result data preview handler

├── proto: task related protocol abstract

├── server

│   ├── mq: actors of message queue

│   └── rpc: actors of RPC server

├── template: static templates

│   └── email_tpl: email template

├── tools: build tools

Build

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Key Modules

List the main modules and thier main logic including the time sequence graph if required.

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Roadmap

  • A
  • B
  • c

Maintainers

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment