Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove outdated install help #169

Merged
merged 1 commit into from
Dec 4, 2019
Merged

Remove outdated install help #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 3 additions & 54 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ This package provides a wrapper around
[Images.jl](https://github.com/timholy/Images.jl) to make image I/O more
modular.

# Installation
## Installation

Add the package with

```julia
Pkg.add("ImageMagick")
```

# Usage
## Usage

ImageMagick will be used as needed if you've said

Expand All @@ -41,57 +41,6 @@ img = load(filename[; view=false])
Set `view=true` to reduce memory consumption when loading large files, possibly
at some slight cost in terms of performance of future operations.


# Troubleshooting

## OSX

ImageMagick.jl will use the system-wide libMagicWand in `/usr/local/lib` if it is
present. Use the environment variable `MAGICK_HOME` to add other paths to the search
path. Note that version 6.7+ (up to but not including 7.0) are the most supported versions, in
particular for multipage TIFFs. Use `ImageMagick.libversion` to see what version the installer
found. If ImageMagick.jl doesn't find a previous installation, it will install its own copy of the
ImageMagick library with Homebrew.jl.

ImageMagick.jl 0.3.0 introduced significant improvements in the installation procedure for OSX users.
If you've had trouble with previous versions of ImageMagick.jl and attempted to resolve problems manually,
some of your workarounds might interfere with the new approach. You can reset your build with

```julia
using Homebrew
Homebrew.rm("imagemagick@6")
Homebrew.brew(`prune`)
Pkg.build("ImageMagick")
```

You may also find [debugging
Homebrew](https://github.com/JuliaLang/Homebrew.jl/wiki/Debugging-Homebrew.jl)
useful.

Finally, an alternative to ImageMagick on OS X is
[QuartzImageIO](https://github.com/JuliaIO/QuartzImageIO.jl).


## Manual installation on Windows

If automatic installation fails, get the current version from
http://www.imagemagick.org/script/binary-releases.php#windows
(e.g. ImageMagick-6.8.8-7-Q16-x86-dll.exe) and make sure that the "Install
development headers and libraries for C and C++" checkbox is selected. You may
choose to let the installer add the installation directory to the system path or
provide it separately. In the later case you may add it to your `.juliarc.jl`
file as (for example) `push!(Base.DL_LOAD_PATH,
"C:/programs/ImageMagick-6.8.8"`). Alternatively, you can set your `MAGICK_HOME` environment variable.

**When manual intervention is necessary, you need to restart Julia for the
necessary changes to take effect.**

## Linux

ImageMagick.jl automatically searches for an installed version of
libMagickWand. Use the environment variable `MAGICK_HOME` to add to the search
path. Use `ImageMagick.libversion()` to see what version it found. Version 6.7+
(up to but not including 7.0) are the most supported versions, in particular
for multipage TIFFs.
## Advanced usage

The environment variable `MAGICK_THREAD_LIMIT` can be used to throttle multithreading.