Add a description for installing GraphicsMagick or ImageMagick in docs/README.md #4045
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.
Description of the Change
To try to contribute to Mocha docs, I proceeded with the installation as described in README.md of docs directory. However, when I tried to use
npm start docs
after installing, the following error occurred:After searching, I installed GraphicsMagick and finally I was able to make it work. It is understood that GraphicsMagick must be installed for execution, but I believe there is not enough explanation about it. Therefore, I think some additional description of this case can be more helpful for beginners(like me!). I propose to add the description as follows:
npm start docs
, follow this guide to install GraphicsMagick.Benefits
I believe it can be more helpful for beginners.