Skip to content

Commit 805f5d1

Browse files
committed
Restructure docs and assets, update metadata
Moved documentation files to the docs/ directory and assets to assets/. Updated pyproject.toml to reference docs/README.md and changed version to 1.0.0. Added new optional development dependencies. Updated requirements.txt to match dev dependencies. Renamed and relocated example and screenshot files. Updated main.py metadata to reflect new version and project structure.
1 parent b2320e0 commit 805f5d1

File tree

16 files changed

+1244
-268
lines changed

16 files changed

+1244
-268
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 181 deletions
This file was deleted.

assets/sharpify-gui-logo.ico

15 KB
Binary file not shown.

docs/CHANGELOG.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-06-11
9+
10+
### Added
11+
- 🎉 **Initial release** with core download and UI functionality
12+
-**Video Upscaling** support via frame‑by‑frame Real‑ESRGAN + FFmpeg reassembly
13+
-**Multi‑threaded** batch processing with real‑time progress bars
14+
-**Advanced Settings** dialog: model selection, GPU toggle, tile size, FPS & quality
15+
-**Comprehensive Logging** system with save/load capability
16+
-**Drag‑and‑Drop** interface enhancements
17+
18+
### Security
19+
- Added SECURITY.md
20+
21+
---
22+
23+
## Guidelines for Contributors
24+
25+
When adding entries to this changelog:
26+
27+
1. **Group changes** by type using the categories above
28+
2. **Write for humans** - use clear, descriptive language
29+
3. **Include issue/PR numbers** when relevant: `Fixed login bug (#123)`
30+
4. **Date format** should be YYYY-MM-DD
31+
5. **Version format** should follow [Semantic Versioning](https://semver.org/)
32+
6. **Keep entries concise** but informative
33+
34+
### Version Number Guidelines
35+
- **Major** (X.y.z) - Breaking changes
36+
- **Minor** (x.Y.z) - New features, backwards compatible
37+
- **Patch** (x.y.Z) - Bug fixes, backwards compatible
38+
39+
### Example Entry Format
40+
```markdown
41+
## [1.2.3] - 2024-01-15
42+
43+
### Added
44+
- New feature description (#PR-number)
45+
46+
### Fixed
47+
- Bug fix description (fixes #issue-number)
48+
```
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Examples of unacceptable behavior include:
4040

4141
Community leaders are responsible for clarifying and enforcing our standards and
4242
will take appropriate and fair corrective action in response to any behavior that
43-
they deem inappropriate, threatening,offensive, or harmful.
43+
they deem inappropriate, threatening, offensive, or harmful.
4444

4545
Community leaders have the right and responsibility to remove, edit, or reject
4646
comments, commits, code, wiki edits, issues, and other contributions that are

0 commit comments

Comments
 (0)