From 640a2bf0d50da9dc51b7041545138ed2c174b849 Mon Sep 17 00:00:00 2001 From: Stephen Klein Date: Thu, 17 Jul 2025 22:09:53 -0400 Subject: [PATCH] Add macOS support documentation to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated platform badge to show Linux | macOS support - Added macOS system requirements (Big Sur+, Intel/Apple Silicon) - Updated prerequisites with platform-specific details: • Linux: Root access, x86_64 architecture • macOS: Admin access, automatic Homebrew/Docker installation - Fixed installation commands for renamed scripts (no .sh extensions) - Added cross-platform support to "What's New" features - Clarified that HOPS works natively on both platforms Now GitHub users will know macOS is fully supported\! 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d47253..f8ca964 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/Version-3.1.0-blue.svg)]() -[![Platform](https://img.shields.io/badge/Platform-Ubuntu%2FDebian%2FMint-orange.svg)]() +[![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS-orange.svg)]() **HOPS** is a comprehensive, automated deployment solution for popular homelab applications. It simplifies the process of setting up and managing Docker-based services including media servers, download clients, monitoring tools, and more. @@ -19,6 +19,7 @@ - **🔧 Enhanced Error Handling**: Better error messages and recovery mechanisms - **🎯 Improved Service Definitions**: Standardized service generation with validation - **📖 Documentation**: Complete `CLAUDE.md` for development guidance +- **🍎 Cross-Platform Support**: Native support for both Linux and macOS with automatic dependency installation ### Installation Methods - **🚀 New Secure Installer**: `sudo ./setup` - Recommended method @@ -110,15 +111,27 @@ HOPS (Homelab Orchestration Provisioning Script) automates the deployment of a c ## 🔧 System Requirements ### Minimum Requirements -- **OS**: Ubuntu 20.04+, Debian 11+, or Linux Mint 20+ +- **OS**: + - **Linux**: Ubuntu 20.04+, Debian 11+, or Linux Mint 20+ + - **macOS**: 11.0+ (Big Sur) with Intel or Apple Silicon - **RAM**: 2GB (4GB+ recommended) - **Storage**: 10GB free space (more for media) - **CPU**: 2 cores recommended - **Network**: Internet connection required ### Prerequisites + +**Linux:** - Root/sudo access - x86_64 architecture +- Internet connection + +**macOS:** +- Admin access (sudo privileges) +- Intel (x86_64) or Apple Silicon (ARM64) +- Internet connection +- Homebrew will be installed automatically if not present +- Docker Desktop will be installed automatically if not present ## 🚀 Quick Start @@ -126,7 +139,7 @@ HOPS (Homelab Orchestration Provisioning Script) automates the deployment of a c ```bash git clone https://github.com/skiercm/hops.git cd hops -chmod +x *.sh +chmod +x hops install uninstall setup ``` ### 2. Run Installation (New Improved Method)