Skip to content

INSTALL.md

Latest commit

 

History

History
157 lines (115 loc) · 3.92 KB

INSTALL.md

File metadata and controls

157 lines (115 loc) · 3.92 KB

BlockMaster Installation Guide

🚀 One-Click Installation (Recommended)

Method 1: DMG Installer (Easiest)

# Download the .dmg file
curl -O https://github.com/bythebug/Block-Master-System-Level-Website-Blocker/releases/latest/download/BlockMaster-2.0.0.dmg

# Double-click to mount and drag to Applications
open BlockMaster-2.0.0.dmg

Method 2: Script Installer

# Download the installer
curl -O https://raw.githubusercontent.com/bythebug/Block-Master-System-Level-Website-Blocker/main/install.sh

# Make it executable and run
chmod +x install.sh
./install.sh

Method 3: Quick Download Script

# Download and run the quick installer
curl -s https://raw.githubusercontent.com/bythebug/Block-Master-System-Level-Website-Blocker/main/download.sh | bash

📋 What the DMG Installer Does

The BlockMaster .dmg installer provides:

  1. Professional App Bundle

    • Native macOS application structure
    • Proper Info.plist configuration
    • Executable script for launching

  2. Complete Source Code

    • All Python source files included
    • Documentation and scripts
    • Requirements file for dependencies

  3. Easy Installation

    • Drag-and-drop to Applications folder
    • Automatic dependency installer included
    • User-friendly README with instructions

📋 What the Script Installer Does

The BlockMaster script installer will:

  1. Check System Requirements

    • Verify macOS compatibility
    • Check Python 3 installation
    • Verify pip3 availability
    • Check Git installation

  2. Download BlockMaster

    • Clone the repository to ~/Applications/BlockMaster
    • Download all source code and dependencies

  3. Install Dependencies

    • Install Python packages from requirements.txt
    • Install tkinter if needed
    • Set up proper permissions

  4. Create Shortcuts

    • Desktop shortcut for easy access
    • Applications folder shortcut
    • Make all scripts executable

  5. Test Installation

    • Verify all components work
    • Test import functionality
    • Confirm ready to use

🖥️ After Installation

Launch BlockMaster (DMG Installation)

  • Double-click BlockMaster.app in your Applications folder
  • Or run: open /Applications/BlockMaster.app

Launch BlockMaster (Script Installation)

  • Double-click BlockMaster.command on your Desktop
  • Or run: python3 ~/Applications/BlockMaster/src/launcher.py

First Run

  1. BlockMaster will request administrator privileges
  2. Enter your password when prompted
  3. Start blocking websites immediately!

🛠️ Manual Installation (Advanced)

If you prefer manual installation:

# Clone the repository
git clone https://github.com/bythebug/blockmaster.git
cd blockmaster

# Install dependencies
pip3 install -r requirements.txt

# Install tkinter (if needed)
brew install python-tk

# Run BlockMaster
python3 src/launcher.py

⚠️ Requirements

  • macOS: 10.12 (Sierra) or later
  • Python: 3.6 or later
  • Administrator Privileges: Required for system file modification
  • Internet Connection: For downloading and installation

🔧 Troubleshooting

Python Not Found

# Install Python via Homebrew
brew install python3

# Or download from python.org
# https://www.python.org/downloads/

tkinter Not Available

# Install tkinter
brew install python-tk

Permission Issues

  • Make sure you're running the installer with proper permissions
  • The installer will request sudo access when needed

Installation Fails

  • Check your internet connection
  • Ensure you have sufficient disk space
  • Try running the installer again

📞 Support

📄 License

BlockMaster is licensed under the MIT License - see LICENSE for details.

Made with ❤️ for macOS users who want true system-level website blocking