Improve README #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Most users will not wish to install this for their program to execute,
so we can file it as a development package.
With this change users must explicitly ask to install dev packages:
php composer.phar update --dev
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I made some wording changes and improved the formatting of the README.
Also included is suggesting to install this package as a Composer dev package. Your original README suggested installing this for the Symfony2 dev environment already, so we should follow that with Composer.
Most developers will not need to use phpdoc while in production, so they will only use it while on their local or test/build machine. This way the bundle and phpdocumentor itself will not need to be installed anywhere else.