Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 45 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,46 @@ MyMacCleaner is a free, open-source alternative to commercial Mac cleaning apps

## Screenshots

*Coming soon*
### Home & Smart Scan
<p align="center">
<img src="website/public/screenshots/home/home_base.png" alt="Home Screen" width="45%">
<img src="website/public/screenshots/home/home_full.png" alt="Smart Scan Results" width="45%">
</p>

### Disk Cleaner & Space Lens
<p align="center">
<img src="website/public/screenshots/disk_cleaner/disk_cleaner_full.png" alt="Disk Cleaner" width="45%">
<img src="website/public/screenshots/disk_cleaner/space_lens.png" alt="Space Lens" width="45%">
</p>

### Performance & System Health
<p align="center">
<img src="website/public/screenshots/performance/performance.png" alt="Performance" width="45%">
<img src="website/public/screenshots/system_health/system_health.png" alt="System Health" width="45%">
</p>

### Applications & Port Management
<p align="center">
<img src="website/public/screenshots/applications/applications_full.png" alt="Applications" width="45%">
<img src="website/public/screenshots/port_management/port_managment.png" alt="Port Management" width="45%">
</p>

### Duplicates & Orphaned Files
<p align="center">
<img src="website/public/screenshots/duplicates/duplicates_full.png" alt="Duplicates" width="45%">
<img src="website/public/screenshots/orphaned_files/orphaned_files_full.png" alt="Orphaned Files" width="45%">
</p>

### Startup Items & Permissions
<p align="center">
<img src="website/public/screenshots/startup_items/startup_items_full.png" alt="Startup Items" width="45%">
<img src="website/public/screenshots/permissions/permissions.png" alt="Permissions" width="45%">
</p>

### Menu Bar Monitor
<p align="center">
<img src="website/public/screenshots/menu/menu.png" alt="Menu Bar" width="30%">
</p>

## Requirements

Expand Down Expand Up @@ -104,13 +143,17 @@ See [Permissions Guide](docs/permissions.md) for detailed information.
- [Menu Bar Monitor](docs/menu-bar.md)
- [Permissions Guide](docs/permissions.md)

## Automatic Updates

MyMacCleaner includes built-in automatic update checking powered by the Sparkle framework. The app periodically checks for new versions in the background, and when an update is available, a notification button appears next to the language switcher in the app toolbar. This provides a seamless update experience - simply click the button to download and install the latest version without leaving the app.

## Tech Stack

- **Language**: Swift 5.9+
- **UI Framework**: SwiftUI
- **Design**: Apple Liquid Glass (macOS Tahoe style)
- **Concurrency**: Swift async/await, TaskGroups
- **Updates**: Sparkle Framework
- **Updates**: Sparkle Framework (automatic background checks with in-app notification)

## Attribution

Expand Down
10 changes: 10 additions & 0 deletions docs/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Complete application management: uninstall apps properly and check for updates.

![Applications - Before Analysis](/MyMacCleaner/screenshots/applications/applications_base.png)
*Applications Manager ready to analyze your installed apps*

## Overview

The Applications Manager helps you:
Expand All @@ -12,6 +15,9 @@ The Applications Manager helps you:

## Application List

![Applications - Full List](/MyMacCleaner/screenshots/applications/applications_full.png)
*Grid view showing all installed applications with size and update status*

### Views

- **Grid View** - Visual display with app icons
Expand Down Expand Up @@ -85,6 +91,10 @@ MyMacCleaner scans for all related files before uninstalling.

## Update Checker

### Automatic Update Notifications

MyMacCleaner itself automatically checks for updates in the background using the Sparkle framework. When a new version is available, an update notification button appears next to the language switcher in the app toolbar. This seamless experience lets you update the app without interrupting your workflow - simply click the button to download and install the latest version.

### Supported Update Sources

| Source | Detection Method |
Expand Down
9 changes: 9 additions & 0 deletions docs/disk-cleaner.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

Deep cleaning functionality to remove junk files and free up disk space.

![Disk Cleaner - Before Scan](/MyMacCleaner/screenshots/disk_cleaner/disk_cleaner_base.png)
*Disk Cleaner ready to scan for junk files*

## Overview

Disk Cleaner provides granular control over what gets cleaned, with detailed categories and safe deletion practices.

![Disk Cleaner - Scan Results](/MyMacCleaner/screenshots/disk_cleaner/disk_cleaner_full.png)
*Detailed scan results showing all cleanable categories*

## Categories

### System Junk
Expand Down Expand Up @@ -59,6 +65,9 @@ Web browser caches and data.

The Browser Privacy tab provides deep cleaning of browser data for enhanced privacy.

![Browser Privacy](/MyMacCleaner/screenshots/disk_cleaner/privacy.png)
*Browser Privacy tab for deep cleaning browser data*

### Supported Browsers

| Browser | Supported |
Expand Down
6 changes: 6 additions & 0 deletions docs/duplicates.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

Find and remove duplicate files to reclaim wasted disk space.

![Duplicates - Before Scan](/MyMacCleaner/screenshots/duplicates/duplicates_base.png)
*Duplicate Finder ready to scan for duplicate files*

## Overview

The Duplicate Finder scans your folders for exact duplicate files using SHA256 hashing. It identifies files with identical content regardless of their names or locations, helping you safely remove redundant copies.

![Duplicates - Results](/MyMacCleaner/screenshots/duplicates/duplicates_full.png)
*Scan results showing duplicate file groups with statistics*

## How It Works

The scanner uses a multi-stage process optimized for speed and accuracy:
Expand Down
6 changes: 6 additions & 0 deletions docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

The Home screen is your dashboard for quick system overview and one-click cleanup.

![Home Screen - Before Scan](/MyMacCleaner/screenshots/home/home_base.png)
*Home screen with Smart Scan ready to analyze your system*

## Overview

When you open MyMacCleaner, the Home screen provides:
Expand Down Expand Up @@ -49,6 +52,9 @@ After scanning, you'll see:
- Individual items you can select/deselect
- Safety indicators for each item

![Home Screen - After Scan](/MyMacCleaner/screenshots/home/home_full.png)
*Scan results showing cleanable categories and total space to recover*

## Quick Actions

Shortcuts to common tasks:
Expand Down
3 changes: 3 additions & 0 deletions docs/menu-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Monitor your Mac's performance at a glance from the menu bar.

![Menu Bar](/MyMacCleaner/screenshots/menu/menu.png)
*Menu Bar popover showing CPU, Memory, and Disk stats with quick actions*

## Overview

The Menu Bar Monitor provides real-time CPU and RAM monitoring directly in your menu bar. Click to see detailed stats and quick actions without opening the full app.
Expand Down
6 changes: 6 additions & 0 deletions docs/orphaned-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

Detect and remove leftover files from applications that have been uninstalled.

![Orphaned Files - Before Scan](/MyMacCleaner/screenshots/orphaned_files/orphaned_files_base.png)
*Orphaned Files scanner ready to detect leftover files*

## Overview

When you delete an application by dragging it to the Trash, many associated files remain on your system. These "orphaned files" can accumulate over time, taking up valuable disk space. The Orphaned Files scanner identifies these remnants and helps you safely remove them.

![Orphaned Files - Results](/MyMacCleaner/screenshots/orphaned_files/orphaned_files_full.png)
*Scan results showing orphaned files grouped by category*

## What Are Orphaned Files?

Orphaned files are support files that were created by applications but remain after the app is uninstalled. They include:
Expand Down
3 changes: 3 additions & 0 deletions docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

System optimization tools and maintenance tasks.

![Performance](/MyMacCleaner/screenshots/performance/performance.png)
*Performance dashboard showing memory usage, processes, and maintenance options*

## Overview

The Performance section provides tools to optimize your Mac's speed and responsiveness through memory management and system maintenance.
Expand Down
3 changes: 3 additions & 0 deletions docs/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Understanding and managing permissions for MyMacCleaner.

![Permissions](/MyMacCleaner/screenshots/permissions/permissions.png)
*Permissions management page showing folder access status*

## Overview

MyMacCleaner needs certain permissions to access system files and perform cleanup operations. This guide explains what permissions are needed, why, and how to grant them.
Expand Down
3 changes: 3 additions & 0 deletions docs/port-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

View and manage processes using network ports.

![Port Management](/MyMacCleaner/screenshots/port_management/port_managment.png)
*Port Management showing active network connections and listening ports*

## Overview

Port Management helps developers and power users see what's running on their Mac's network ports and terminate processes when needed.
Expand Down
3 changes: 3 additions & 0 deletions docs/space-lens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Visual disk space analyzer with interactive treemap visualization.

![Space Lens](/MyMacCleaner/screenshots/disk_cleaner/space_lens.png)
*Interactive treemap visualization showing disk usage by folder and file*

## Overview

Space Lens helps you understand where your disk space is going through an intuitive visual representation. Find large files and folders at a glance.
Expand Down
6 changes: 6 additions & 0 deletions docs/startup-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

Manage applications and services that launch automatically when you log in.

![Startup Items - Before Scan](/MyMacCleaner/screenshots/startup_items/startup_items_base.png)
*Startup Items ready to discover login items and launch agents*

## Overview

Startup Items helps you control what runs when your Mac starts, improving boot time and reducing resource usage.

![Startup Items - Full List](/MyMacCleaner/screenshots/startup_items/startup_items_full.png)
*Complete list of startup items with enable/disable controls*

## Quick Stats

The dashboard shows four key metrics:
Expand Down
3 changes: 3 additions & 0 deletions docs/system-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Monitor your Mac's overall health with a comprehensive health score and detailed system information.

![System Health](/MyMacCleaner/screenshots/system_health/system_health.png)
*System Health dashboard showing health score gauge and system information*

## Overview

System Health provides an at-a-glance view of your Mac's condition through a health score gauge, individual health checks, and detailed system information.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading