Skip to content

Commit 1cf5a67

Browse files
author
Paul M. Jones
committed
move tooling documentation to docs dir
1 parent 23febf6 commit 1cf5a67

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ packages.
66
Please see <https://github.com/php-pds/skeleton_research> for background
77
information.
88

9+
Command-line tools included with this standard are documented [here](./docs/tools.md).
10+
911
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
1012
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be
1113
interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).
@@ -36,20 +38,6 @@ A package MUST use these names for these root-level files:
3638
A package SHOULD include a root-level file indicating the licensing and
3739
copyright terms of the package contents.
3840

39-
## Validator
40-
41-
Quickly validate your project's compliance by following these steps:
42-
43-
- Install package in your project: `composer require pds/skeleton @dev`
44-
- Run the validator: `vendor/bin/pdsskeleton validate`
45-
46-
## Generator
47-
48-
Generate a compliant package skeleton by following these steps:
49-
50-
- Install package in your project: `composer require pds/skeleton @dev`
51-
- Run the generator: `vendor/bin/pdsskeleton generate`
52-
5341
## Root-Level Directories
5442

5543
### bin/

docs/tools.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Command-Line Tools
2+
3+
## Validator
4+
5+
Validate your project's compliance by following these steps:
6+
7+
- Install package in your project: `composer require pds/skeleton @dev`
8+
- Run the validator: `vendor/bin/pdsskeleton validate`
9+
10+
## Generator
11+
12+
Generate a compliant package skeleton by following these steps:
13+
14+
- Install package in your project: `composer require pds/skeleton @dev`
15+
- Run the generator: `vendor/bin/pdsskeleton generate`

0 commit comments

Comments
 (0)