6
6
4 . Add any libraries, assets, or hard dependencies whose source code will be included
7
7
in the project's repository to the _ Exceptions_ section in the [ TERMS] ( TERMS.md ) .
8
8
- If no exceptions are needed, remove that section from TERMS.
9
- 5 . If working with an existing code base, answer the questions on the [ open source checklist] ( opensource-checklist.md )
9
+ 5 . If working with an existing code base, answer the questions on the [ open source checklist] ( opensource-checklist.md )
10
10
6 . Delete these instructions and everything up to the _ Project Title_ from the README.
11
11
7 . Write some great software and tell people about it.
12
12
17
17
# Project Title
18
18
19
19
** Description** : Put a meaningful, short, plain-language description of what
20
- this project is trying to accomplish and why it matters.
20
+ this project is trying to accomplish and why it matters.
21
21
Describe the problem(s) this project solves.
22
22
Describe how this software can improve the lives of its audience.
23
23
@@ -36,24 +36,24 @@ Other things to include:
36
36
37
37
## Dependencies
38
38
39
- Describe any dependencies that must be installed for this software to work.
39
+ Describe any dependencies that must be installed for this software to work.
40
40
This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth.
41
- If specific versions of other software are required, or or known not to work, call that out.
41
+ If specific versions of other software are required, or known not to work, call that out.
42
42
43
43
## Installation
44
44
45
45
Detailed instructions on how to install, configure, and get the project running.
46
- This should be frequently tested to ensure reliability. Alternatively, a link to
47
- another page is fine, but it's important that this works .
46
+ This should be frequently tested to ensure reliability. Alternatively, link to
47
+ a separate [ INSTALL ] ( INSTALL.md ) document .
48
48
49
49
## Configuration
50
50
51
51
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
52
52
53
53
## Usage
54
54
55
- Show users how to use the software.
56
- Be specific.
55
+ Show users how to use the software.
56
+ Be specific.
57
57
Use appropriate formatting when showing code snippets.
58
58
59
59
## How to test the software
@@ -95,4 +95,4 @@ General instructions on _how_ to contribute should be stated with a link to [CON
95
95
96
96
1 . Projects that inspired you
97
97
2 . Related projects
98
- 3 . Books, papers, talks, or other sources that have meaniginful impact or influence on this project
98
+ 3 . Books, papers, talks, or other sources that have meaniginful impact or influence on this project
0 commit comments