Skip to content

Commit 5c20da0

Browse files
committed
add description to install imagemagick
1 parent d4457f7 commit 5c20da0

4 files changed

Lines changed: 41 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,14 @@ Optimize images to meet size requirements:
118118
./scripts/optimize_images.sh all-pubs
119119
```
120120

121-
**Requirements**: ImageMagick (`brew install imagemagick`)
121+
**Requirements**: ImageMagick
122+
123+
**Installation**:
124+
- macOS: `brew install imagemagick`
125+
- Ubuntu/Debian: `sudo apt-get install imagemagick`
126+
- Fedora/RHEL: `sudo yum install imagemagick` or `sudo dnf install imagemagick`
127+
- Arch Linux: `sudo pacman -S imagemagick`
128+
- Windows: Download from [imagemagick.org](https://imagemagick.org/script/download.php#windows) or use `choco install imagemagick`
122129

123130
### Pre-commit Hook
124131

QUICKSTART.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,16 @@ rbenv local 3.1.0
9999

100100
### Images too large
101101
```bash
102-
# Optimize automatically
102+
# Optimize automatically (requires ImageMagick)
103103
./scripts/optimize_images.sh member static/img/members/photo.jpg
104104
./scripts/optimize_images.sh pub static/pub/teaser.jpg
105105
```
106106

107+
**Install ImageMagick**:
108+
- macOS: `brew install imagemagick`
109+
- Linux: `sudo apt-get install imagemagick` or `sudo yum install imagemagick`
110+
- Windows: [imagemagick.org](https://imagemagick.org/script/download.php#windows)
111+
107112
## Useful Commands
108113

109114
```bash

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@ See `CONTRIBUTING.md` for detailed contribution guidelines.
6969
./scripts/optimize_images.sh pub static/pub/paper_id.jpg
7070
```
7171

72-
Requires ImageMagick: `brew install imagemagick`
72+
**Requirements**: ImageMagick
73+
- macOS: `brew install imagemagick`
74+
- Linux: `sudo apt-get install imagemagick` or `sudo yum install imagemagick`
75+
- Windows: See [imagemagick.org](https://imagemagick.org/script/download.php#windows)
7376

7477
### Pre-commit Hook
7578

scripts/optimize_images.sh

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,29 @@ remove_backup() {
7373
# Check if ImageMagick is installed
7474
if ! command -v magick &> /dev/null && ! command -v convert &> /dev/null; then
7575
echo -e "${RED}Error: ImageMagick is not installed${NC}"
76-
echo "Install it with: brew install imagemagick"
76+
echo ""
77+
echo "Please install ImageMagick for your platform:"
78+
echo ""
79+
echo " macOS:"
80+
echo " brew install imagemagick"
81+
echo ""
82+
echo " Ubuntu/Debian Linux:"
83+
echo " sudo apt-get update"
84+
echo " sudo apt-get install imagemagick"
85+
echo ""
86+
echo " Fedora/RHEL/CentOS Linux:"
87+
echo " sudo yum install imagemagick"
88+
echo " # or on newer systems:"
89+
echo " sudo dnf install imagemagick"
90+
echo ""
91+
echo " Arch Linux:"
92+
echo " sudo pacman -S imagemagick"
93+
echo ""
94+
echo " Windows:"
95+
echo " Download from: https://imagemagick.org/script/download.php#windows"
96+
echo " Or use Chocolatey: choco install imagemagick"
97+
echo " Or use Scoop: scoop install imagemagick"
98+
echo ""
7799
exit 1
78100
fi
79101

0 commit comments

Comments
 (0)