medusa/the_information_nexus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update smma/imagemagick.md

Browse Source
This commit is contained in:
medusa
2024-05-31 02:33:07 +00:00
parent 993bcf4b77
commit 2b56243805
1 changed files with 106 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

299
smma/imagemagick.md
View File

@@ -1,8 +1,3 @@
Certainly! Here is a simplified `README.md` that provides clear instructions for setting up the project, cloning the repository, and updating the `zsh` configuration for the alias.
### README.md
```markdown
# Image Converter # Image Converter
This project provides a script to convert WEBP and HEIC images to PNG and JPG formats using ImageMagick. This project provides a script to convert WEBP and HEIC images to PNG and JPG formats using ImageMagick.
@@ -11,27 +6,41 @@ This project provides a script to convert WEBP and HEIC images to PNG and JPG fo
### Prerequisites ### Prerequisites
Make sure you have ImageMagick installed. You can check if it's installed by running: #### Install Homebrew
To install Homebrew, run the following command:
```bash ```bash
convert -version /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
``` ```
If not installed, you can install it using: After installation, add Homebrew to your PATH:
- **macOS**: - For **zsh** (default for macOS Catalina and later):
```bash ```bash
brew install imagemagick echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc
source ~/.zshrc
``` ```
- **Ubuntu**: - For **bash**:
```bash ```bash
sudo apt-get update echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.bash_profile
sudo apt-get install imagemagick source ~/.bash_profile
``` ```
- **Windows**: #### Install ImageMagick
Download and install from the [ImageMagick website](https://imagemagick.org/script/download.php).
With Homebrew installed, run the following command to install ImageMagick:
```bash
brew install imagemagick
```
Verify the installation by checking the version:
```bash
magick --version
```
### Project Setup ### Project Setup
@@ -54,7 +63,7 @@ If not installed, you can install it using:
Replace `~/path_to_your_script_directory` with the actual path where you cloned the repository. Replace `~/path_to_your_script_directory` with the actual path where you cloned the repository.
## Usage ### Usage
To convert a WEBP or HEIC file to PNG and JPG, use the following command: To convert a WEBP or HEIC file to PNG and JPG, use the following command:
@@ -69,151 +78,102 @@ convert filename.heic
``` ```
The converted files will be saved in `~/Pictures/Converted`. The converted files will be saved in `~/Pictures/Converted`.
### Maintenance Commands
Keep Homebrew and its packages up-to-date with the following commands:
- **Update Homebrew**:
```bash
brew update
```
- **Upgrade installed packages**:
```bash
brew upgrade
```
- **Cleanup old versions**:
```bash
brew cleanup
```
## Complete Project Code
### Project Directory Structure
```
image-converter/
├── convert_images.sh
├── README.md
└── .gitignore
``` ```
### Complete Project Code ### convert_images.sh
1. **Project Directory Structure**: ```bash
``` #!/bin/bash
image-converter/
├── convert_images.sh
├── README.md
└── .gitignore
```
2. **convert_images.sh**: # Check if the magick command is available
```bash if ! command -v magick &> /dev/null; then
#!/bin/bash echo "ImageMagick is not installed or not in your PATH."
exit 1
fi
# Check if the magick command is available # Get the input file from the command line argument
if ! command -v magick &> /dev/null; then input_file=$1
echo "ImageMagick is not installed or not in your PATH."
exit 1
fi
# Get the input file from the command line argument # Check if input file is provided
input_file=$1 if [ -z "$input_file" ]; then
echo "Error: No input file specified. Usage: convert file1.webp or convert file1.heic"
exit 1
fi
# Check if input file is provided # Extract the base name and extension of the input file
if [ -z "$input_file" ]; then base_name=$(basename "$input_file" | cut -d. -f1)
echo "Error: No input file specified. Usage: convert file1.webp or convert file1.heic" extension=$(basename "$input_file" | cut -d. -f2)
exit 1
fi
# Extract the base name and extension of the input file # Define the output directory
base_name=$(basename "$input_file" | cut -d. -f1) output_dir="$HOME/Pictures/Converted"
extension=$(basename "$input_file" | cut -d. -f2)
# Define the output directory # Check if the output directory exists, create if it does not
output_dir="$HOME/Pictures/Converted" if [ ! -d "$output_dir" ]; then
mkdir -p "$output_dir"
fi
# Check if the output directory exists, create if it does not # Function to convert images
if [ ! -d "$output_dir" ]; then convert_images() {
mkdir -p "$output_dir" local input_file=$1
fi local base_name=$2
local output_dir=$3
# Function to convert images # Convert to PNG
convert_images() { magick "$input_file" "$output_dir/${base_name}.png"
local input_file=$1 echo "Converted $input_file to $output_dir/${base_name}.png"
local base_name=$2
local output_dir=$3
# Convert to PNG # Convert to JPG
magick "$input_file" "$output_dir/${base_name}.png" magick "$input_file" "$output_dir/${base_name}.jpg"
echo "Converted $input_file to $output_dir/${base_name}.png" echo "Converted $input_file to $output_dir/${base_name}.jpg"
}
# Convert to JPG # Check the file extension and convert if it is .webp or .heic
magick "$input_file" "$output_dir/${base_name}.jpg" if [ "$extension" = "webp" ] || [ "$extension" = "heic" ]; then
echo "Converted $input_file to $output_dir/${base_name}.jpg" convert_images "$input_file" "$base_name" "$output_dir"
} else
echo "Error: The file must be either .webp or .heic."
exit 1
fi
```
# Check the file extension and convert if it is .webp or .heic ### .gitignore
if [ "$extension" = "webp" ] || [ "$extension" = "heic" ]; then
convert_images "$input_file" "$base_name" "$output_dir"
else
echo "Error: The file must be either .webp or .heic."
exit 1
fi
```
3. **.gitignore**: ```gitignore
```gitignore # Ignore log files and temp files
# Ignore log files and temp files *.log
*.log *.tmp
*.tmp ```
```
4. **README.md**: ## Final Steps
```markdown
# Image Converter
This project provides a script to convert WEBP and HEIC images to PNG and JPG formats using ImageMagick.
## Setup Instructions
### Prerequisites
Make sure you have ImageMagick installed. You can check if it's installed by running:
```bash
convert -version
```
If not installed, you can install it using:
- **macOS**:
```bash
brew install imagemagick
```
- **Ubuntu**:
```bash
sudo apt-get update
sudo apt-get install imagemagick
```
- **Windows**:
Download and install from the [ImageMagick website](https://imagemagick.org/script/download.php).
### Project Setup
1. **Clone the repository**:
```bash
git clone https://github.com/yourusername/image-converter.git
cd image-converter
```
2. **Make the script executable**:
```bash
chmod +x convert_images.sh
```
3. **Add an alias to your shell configuration file**:
```bash
echo "alias convert='~/path_to_your_script_directory/convert_images.sh'" >> ~/.zshrc
source ~/.zshrc
```
Replace `~/path_to_your_script_directory` with the actual path where you cloned the repository.
## Usage
To convert a WEBP or HEIC file to PNG and JPG, use the following command:
```bash
convert filename.webp
```
or
```bash
convert filename.heic
```
The converted files will be saved in `~/Pictures/Converted`.
```
### Final Steps
1. **Initialize Git Repository**: 1. **Initialize Git Repository**:
```bash ```bash
@@ -230,51 +190,4 @@ The converted files will be saved in `~/Pictures/Converted`.
git remote add origin https://github.com/yourusername/image-converter.git git remote add origin https://github.com/yourusername/image-converter.git
git branch -M main git branch -M main
git push -u origin main git push -u origin main
``` ```
Now, anyone can clone your repository and follow the instructions in the `README.md` to set up and use the image conversion script.
---
# Install Homebrew
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
# Update your PATH
```bash
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc
```
# Update your shell
```bash
source ~/.zshrc
```
# Install ImageMagick
```bash
brew install imagemagick
```
# Verify the installation
```bash
magick --version
```
---
> Keep Homebrew up-to-date
# Update Homebrew
```bash
brew update
```
# Upgrade installed packages
```bash
brew upgrade
```
# Cleanup old versions
```bash
brew cleanup
```