Readme file writing

Reference material:
https://gist.github.com/PurpleBooth/109311bb0361f32d87a2#project-title

https://github.com/matiassingers/awesome-readme

Project Title

One Paragraph of project description goes here
a paragraph item description

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
These instructions will give you a copy of the project, use For local machine development or testing. Write down the proposal to deploy the project.

Prerequisites

What things you need to install the software and how to install them
what basic software needs to be installed

Give examples

Give a list of cases

Installing

A step by step series of examples that tell you how to get a development env running
a series of examples to show you how to develop and run the steps
Say what the step will be
to tell every step will be to do

Give the example

And repeat

until finished

Until End
End with an example of getting some data out of the system or using it for a little demo
ends with a case, the system or to obtain useful data output

Running the tests

Explain how to run the automated tests for this system
how to detect the operation of the system of automatic test

Break down into end to end tests

Explain what these tests test and why
explain the purpose and significance of these tests

Give an example

And coding style tests

Explain what these tests test and why
explain the purpose and significance of these tests

Give an example

Deployment

Add additional notes about how to deploy this on a live system
to add additional notes on how to deploy the code to a production environment

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Read Conteributing.md , which introduces our code production details and the process of submitting merge requests to us

Versioning

版本控制规则
We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

IS Project at The Licensed an under the this MIT License - See at The LICENSE.md File for the Details
of this project follows the MIT license

Acknowledgments Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
Published 7 original articles · Like 11 · Visits 40,000+

Guess you like

Origin blog.csdn.net/weixin_41682466/article/details/98481578