Skip to content

Commit 21be38f

Browse files
Refactor: Update README
1 parent 15ece44 commit 21be38f

File tree

1 file changed

+6
-38
lines changed

1 file changed

+6
-38
lines changed

README.md

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,15 @@ PhotoSort is a powerful desktop application focused on speed designed to streaml
66

77
## Key Features
88

9-
* **Advanced Sorting & Viewing**:
10-
* Flexible view modes: List, Icons, Grid, and Chronological by Date.
11-
* **Real-time Search**: Instantly filter images by filename with live search results.
129
* **Intelligent Culling Tools**:
13-
* **Ratings & Labels**: Assign star ratings and color labels for quick categorization.
10+
* **Ratings & Labels**: Assign star ratings for quick categorization.
1411
* **Blur Detection**: Automatically identify and flag blurry photos.
12+
* **AI Orientation Detection**: Auto-detects the correct image orientation using a lightweight ONNX model and proposes rotations.
1513
* **Similarity Analysis**: Group visually similar images to easily spot duplicates or near-duplicates.
16-
* **Efficient Workflow**:
17-
* **Advanced Filtering System**:
18-
* Filter images by ratings (Show All, 1+ Stars, 2+ Stars, etc.)
19-
* Filter by similarity clusters when grouping is active
20-
* Combine text search with rating and cluster filters
21-
* Real-time filtering with immediate visual feedback
2214
* **Fast Processing**: Intensive operations (scanning, thumbnailing, analysis) run once in batch to ensure fast image scrolling.
2315
* **Optimized Image Handling**: Supports a wide range of formats, including various RAW types, with efficient caching.
24-
* **File Management**:
25-
* Move unwanted photos to the system trash.
26-
* **Intelligent Image Rotation**: Smart rotation system that automatically tries lossless metadata rotation first, with optional fallback to pixel rotation when needed. Supports all major formats with format-specific optimization.
27-
28-
### Sidebar Features
29-
30-
The sidebar provides quick access to image metadata and organizational tools:
31-
32-
- **Metadata Display**: Shows detailed EXIF information (camera model, exposure settings, etc.) and user-assigned ratings/labels for the currently selected image.
33-
34-
## Technology Stack
35-
36-
* **Core Language**: Python
37-
* **GUI Framework**: PyQt6
38-
* **Image Processing**:
39-
* Pillow (PIL Fork)
40-
* rawpy (for RAW image processing)
41-
* OpenCV (cv2 - for blur detection via Laplacian variance)
42-
* pyexiv2 (for metadata reading/writing and image rotation)
43-
* **Machine Learning / AI**:
44-
* SentenceTransformers (with CLIP models like `clip-ViT-B-32` for image embeddings)
45-
* scikit-learn (for DBSCAN clustering)
46-
* NumPy (for numerical operations)
47-
* ONNX Runtime (for AI model inference)
48-
* **Packaging/Misc**:
49-
* `send2trash` (for moving files to trash)
16+
* **Intelligent Image Rotation**: Smart rotation system that automatically tries lossless metadata rotation first, with optional fallback to pixel rotation when needed.
17+
- **Metadata Display**: Shows EXIF information (camera model, exposure settings, etc.).
5018

5119
## Getting Started
5220

@@ -107,7 +75,7 @@ The application will automatically detect and load the model when you use the ro
10775
1. **Clone the repository (if applicable):**
10876

10977
```bash
110-
git clone <your-repository-url>
78+
git clone https://github.com/duartebarbosadev/photosort
11179
cd PhotoSort
11280
```
11381
2. **Create a virtual environment (recommended):**
@@ -133,7 +101,7 @@ The application will automatically detect and load the model when you use the ro
133101
# python -m src.main --folder "C:/Users/MyUser/Pictures"
134102
# Clear all caches before starting:
135103
# python -m src.main --clear-cache
136-
# Open folder and clear caches:
104+
# Open folder and clear caches (useful for development):
137105
# python -m src.main --folder "C:/Users/MyUser/Pictures" --clear-cache
138106
```
139107

0 commit comments

Comments
 (0)