codehulk/scribe

A documentation generator for packages.

0.1.2 2018-05-31 13:33 UTC

Requires

• php: ^7.0
• codehulk/package-tools: ^0.1
• php-di/php-di: >=5.0 <7.0
• symfony/console: >=2.0 <5.0
• symfony/filesystem: >=2.0 <5.0
• twig/twig: >=2.0 <4.0

Requires (Dev)

• phpunit/phpunit: >=5.0 <8.0

MIT

• Rob Piper

README

This library contains tooling for generating documentation for Packages.

Usage

To run the documentation generator, use the generate command:

vendor/bin/scribe generate path/to/scribe.config.php

Versioning

To tag the documentation with a specific build, or version, use the build option:

vendor/bin/scribe generate path/to/scribe.config.php --build=1.2.3

License

See LICENSE.md.