diff --git a/README.md b/README.md index 08932db..f762cb7 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,23 @@ responsive_image: - assets/avatars/*.{jpeg,jpg} ``` +## Troubleshooting + +### Error: Can't install RMagick + +`jekyll-responsive-image` uses `rmagick` which is currently incompatible with ImageMagick 7. If you get an error like: + +``` +Can't install RMagick 2.16.0. Can't find MagickWand.h +``` + +Then you will need to install ImageMagick 6. If you are using Homebrew on Mac OS, this can be done with the following commands: + +``` +$ brew uninstall imagemagick +$ brew install imagemagick@6 && brew link imagemagick@6 --force +``` + ## Caching You may be able to speed up the build of large sites by enabling render caching. This is usually only effective when the same image is used many times, for example a header image that is rendered in every post. @@ -231,4 +248,4 @@ If you'd like your Jekyll project to use your local fork directly, you can add t gem 'jekyll-responsive-image', :path => "/your/local/path/to/jekyll-responsive-image" ``` -If you'd like your changes to be considered for the original repository, simply submit a pull request after you've made your changes. Please make sure all tests pass. \ No newline at end of file +If you'd like your changes to be considered for the original repository, simply submit a pull request after you've made your changes. Please make sure all tests pass.