Skip to content

Commit 8e9ed29

Browse files
author
Paul M. Jones
committed
make the if/then nature of the standard more apparent
1 parent 99ee535 commit 8e9ed29

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,31 @@ interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).
1212

1313
## Summary
1414

15-
A package MUST use the following names for the following kinds of directories
16-
and files:
17-
18-
```
19-
bin/ # command-line executables
20-
config/ # configuration files
21-
docs/ # documentation and examples
22-
public/ # web server files
23-
resources/ # other resource files
24-
src/ # PHP source code
25-
tests/ # test code
26-
vendor/ # reserved for package managers
27-
CHANGELOG(.*) # a log of changes between releases
28-
CONTRIBUTING(.*) # guidelines for contributors
29-
LICENSE(.*) # licensing information
30-
README(.*) # information about the package itself
31-
```
15+
A package MUST use these names for these root-level directories:
16+
17+
| If a package has a root-level directory for ... | ... then it MUST be named: |
18+
| ----------------------------------------------- | -------------------------- |
19+
| command-line executables | `bin/` |
20+
| configuration files | `config/` |
21+
| documentation and examples | `docs/` |
22+
| web server files | `public/` |
23+
| other resource files | `resources/` |
24+
| PHP source code | `src/` |
25+
| test code | `tests/` |
26+
27+
The root-level directory `vendor/` MUST be reserved for package managers.
28+
29+
A package MUST use these names for these root-level files:
30+
31+
| If a package has a root-level file for ... | ... then it MUST be named: |
32+
| ----------------------------------------------- | -------------------------- |
33+
| a log of changes between releases | `CHANGELOG(.*)` |
34+
| guidelines for contributors | `CONTRIBUTING(.*)` |
35+
| licensing information | `LICENSE(.*)` |
36+
| information about the package itself | `README(.*)` |
37+
38+
A package SHOULD include a root-level file indicating the licensing and
39+
copyright terms of the package contents.
3240

3341
## Root-Level Directories
3442

0 commit comments

Comments
 (0)