Skip to content

Commit 42b0109

Browse files
author
Paul M. Jones
committed
emphasize that the directories and files are root-level
1 parent 8d4127f commit 42b0109

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,31 @@ README # information about the package itself
3232

3333
### bin/
3434

35-
If the package provides a directory for command-line executable files, it MUST
35+
If the package provides a root-level directory for command-line executable files, it MUST
3636
be named `bin/`.
3737

3838
This publication does not otherwise define the structure and contents of the
3939
directory.
4040

4141
### config/
4242

43-
If the package provides a directory for configuration files, it MUST be named
43+
If the package provides a root-level directory for configuration files, it MUST be named
4444
`config/`.
4545

4646
This publication does not otherwise define the structure and contents of the
4747
directory.
4848

4949
### docs/
5050

51-
If the package provides a directory for documentation files, it MUST be named
51+
If the package provides a root-level directory for documentation files, it MUST be named
5252
`docs/`.
5353

5454
This publication does not otherwise define the structure and contents of the
5555
directory.
5656

5757
### public/
5858

59-
If the package provides a directory for web server files, it MUST be named
59+
If the package provides a root-level directory for web server files, it MUST be named
6060
`public/`.
6161

6262
This publication does not otherwise define the structure and contents of the
@@ -69,15 +69,15 @@ directory.
6969
7070
### src/
7171

72-
If the package provides a directory for source code files, it MUST be named
72+
If the package provides a root-level directory for source code files, it MUST be named
7373
`src/`.
7474

7575
This publication does not otherwise define the structure and contents of the
7676
directory.
7777

7878
### tests/
7979

80-
If the package provides a directory for test files, it MUST be named `tests/`.
80+
If the package provides a root-level directory for test files, it MUST be named `tests/`.
8181

8282
This publication does not otherwise define the structure and contents of the
8383
directory.
@@ -107,7 +107,7 @@ directories.
107107

108108
### CHANGELOG
109109

110-
If the package provides a file with a list of changes since the last release or
110+
If the package provides a root-level file with a list of changes since the last release or
111111
version, it MUST be named `CHANGELOG`.
112112

113113
It MAY have a lowercase filename extension indicating the file format.
@@ -117,7 +117,7 @@ file.
117117

118118
### CONTRIBUTING
119119

120-
If the package provides a file that describes how to contribute to the package,
120+
If the package provides a root-level file that describes how to contribute to the package,
121121
it MUST be named `CONTRIBUTING`.
122122

123123
It MAY have a lowercase filename extension indicating the file format.
@@ -127,7 +127,7 @@ file.
127127

128128
### LICENSE
129129

130-
If the package provides a file with licensing information, it MUST be named
130+
If the package provides a root-level file with licensing information, it MUST be named
131131
`LICENSE`.
132132

133133
It MAY have a lowercase filename extension indicating the file format.
@@ -137,7 +137,7 @@ file.
137137

138138
### README
139139

140-
If the package provides a file with information about the package itself, it
140+
If the package provides a root-level file with information about the package itself, it
141141
MUST be named `README`.
142142

143143
It MAY have a lowercase filename extension indicating the file format.

0 commit comments

Comments
 (0)