Skip to content

Commit

Permalink
move tooling documentation to docs dir
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul M. Jones committed Jan 8, 2017
1 parent 23febf6 commit 1cf5a67
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 14 deletions.
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ packages.
Please see <https://github.com/php-pds/skeleton_research> for background
information.

Command-line tools included with this standard are documented [here](./docs/tools.md).

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be
interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).
Expand Down Expand Up @@ -36,20 +38,6 @@ A package MUST use these names for these root-level files:
A package SHOULD include a root-level file indicating the licensing and
copyright terms of the package contents.

## Validator

Quickly validate your project's compliance by following these steps:

- Install package in your project: `composer require pds/skeleton @dev`
- Run the validator: `vendor/bin/pdsskeleton validate`

## Generator

Generate a compliant package skeleton by following these steps:

- Install package in your project: `composer require pds/skeleton @dev`
- Run the generator: `vendor/bin/pdsskeleton generate`

## Root-Level Directories

### bin/
Expand Down
15 changes: 15 additions & 0 deletions docs/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Command-Line Tools

## Validator

Validate your project's compliance by following these steps:

- Install package in your project: `composer require pds/skeleton @dev`
- Run the validator: `vendor/bin/pdsskeleton validate`

## Generator

Generate a compliant package skeleton by following these steps:

- Install package in your project: `composer require pds/skeleton @dev`
- Run the generator: `vendor/bin/pdsskeleton generate`

0 comments on commit 1cf5a67

Please sign in to comment.