一个好用的README模板

文章来自微信公众号“科文路”,欢迎关注、互动。转发须注明出处。

推荐一个好用的 README 的 Markdown 模板。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Project Title

One Paragraph of project description goes here

## 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.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you how 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

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

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

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/ "Dropwizard") - The web framework used
* [Maven](https://maven.apache.org/ "Maven") - Dependency Management
* [ROME](https://rometools.github.io/rome/ "ROME") - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426 "CONTRIBUTING.md") for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/ "SemVer") for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags "tags on this repository").

## Authors

* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth "PurpleBooth")

See also the list of [contributors](https://github.com/your/project/contributors "contributors") who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md "LICENSE.md") file for details

## Acknowledgments

* Hat tip to anyone whose code was used
* Inspiration
* etc

都看到这儿了,不如关注每日推送的“科文路”、互动起来~

Author

xlindo

Posted on

2022-05-06

Updated on

2023-05-10

Licensed under

Comments