2017 © Pedro Peláez
 

library composerdoc

Console tool for displaying package documentation.

image

jwpage/composerdoc

Console tool for displaying package documentation.

  • Wednesday, July 10, 2013
  • by jwpage
  • Repository
  • 2 Watchers
  • 16 Stars
  • 21 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 6 Versions
  • 0 % Grown

The README.md

Composerdoc Command Line Utility

[Build Status](https://travis-ci. org/jwpage/composerdoc), (*1)

Composerdoc is a tool that allows you to dump a listing of the required packages within your project to a markdown format for documentation purposes., (*2)

Installation

Add this to your composer.json by running composer.phar require jwpage/composerdoc --dev., (*3)

Or alternatively, as Composerdoc is a documentation tool, you can install it separately and run it with the --path option., (*4)

echo -n '{ "require": { "jwpage/composerdoc": "*" } }' > composer.json
composer.phar install

Usage

composerdoc dump

To generate composerdoc output:, (*5)

./vendor/bin/composerdoc --path <path_to_composer.json_dir>

To include dev requirements:, (*6)

./vendor/bin/composerdoc --dev

To include requirements of requirements:, (*7)

./vendor/bin/composerdoc --sub

composerdoc check

You can use composerdoc to check if a README file has the latest composerdoc information., (*8)

./vendor/bin/composerdoc --path <README.markdown>

This command takes the same options as the composerdoc dump command., (*9)

composerdoc update

You can also automatically update a README file with the latest composerdoc information in one command., (*10)

./vendor/bin/composerdoc --path <README.markdown>

This command takes the same options as the composerdoc dump command., (*11)

Example Output

Required Packages, (*12)

Dev Packages, (*13)

Running Tests

First, install PHPUnit with composer.phar install --dev, then run ./vendor/bin/phpunit., (*14)

The Versions

10/07 2013

dev-master

9999999-dev

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation

10/07 2013

v2.0.0

2.0.0.0

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation

10/07 2013

v1.1.1

1.1.1.0

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation

19/02 2013

v1.1.0

1.1.0.0

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation

22/01 2013

v1.0.1

1.0.1.0

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation

21/01 2013

v1.0.0

1.0.0.0

Console tool for displaying package documentation.

  Sources   Download

MIT

The Requires

 

The Development Requires

composer documentation