mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-21 22:00:07 -05:00
Dries Peeters
5fb49ad375
- Move API, ARCHITECTURE, BUILD, DEVELOPMENT, and fix docs to docs/ - Move README variants and WINDOWS_BUILD to docs/ - Move assets and screenshots to docs/assets/ - Update GETTING_STARTED, README, CONTRIBUTOR_GUIDE, PROJECT_STRUCTURE, LOCAL_TESTING_WITH_SQLITE, VERSION_MANAGEMENT
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Assets Directory
|
|
|
|
This directory contains static assets for the TimeTracker GitHub Pages website.
|
|
|
|
## Files to Add
|
|
|
|
### Required Assets
|
|
- `favicon.ico` - Website favicon (16x16 or 32x32 pixels)
|
|
- `og-image.png` - Open Graph image for social media sharing (1200x630 pixels recommended)
|
|
|
|
### Optional Assets
|
|
- `logo.png` - Project logo (various sizes: 32x32, 64x64, 128x128, 256x256)
|
|
- `screenshots/` - Directory for application screenshots
|
|
- `icons/` - Additional icon files
|
|
|
|
## Image Guidelines
|
|
|
|
### Favicon
|
|
- Format: ICO or PNG
|
|
- Size: 16x16, 32x32, or 48x48 pixels
|
|
- Should be simple and recognizable
|
|
|
|
### Open Graph Image
|
|
- Format: PNG or JPG
|
|
- Size: 1200x630 pixels (1.91:1 aspect ratio)
|
|
- Should include project name and key visual elements
|
|
- Text should be readable at small sizes
|
|
|
|
### Screenshots
|
|
- Format: PNG or JPG
|
|
- Size: Minimum 800x600 pixels
|
|
- Should showcase key features of the application
|
|
- Include descriptive filenames
|
|
|
|
## Current Status
|
|
- ✅ `README.md` - This file
|
|
- ✅ `screenshots/` - Added 3 application screenshots
|
|
- ❌ `favicon.ico` - Need to create
|
|
- ❌ `og-image.png` - Need to create
|
|
|
|
## Creating Assets
|
|
|
|
### Favicon
|
|
You can create a simple favicon using online tools like:
|
|
- [Favicon.io](https://favicon.io/)
|
|
- [RealFaviconGenerator](https://realfavicongenerator.net/)
|
|
|
|
### Open Graph Image
|
|
Create using design tools like:
|
|
- Canva
|
|
- Figma
|
|
- GIMP
|
|
- Photoshop
|
|
|
|
Or use online tools like:
|
|
- [Canva](https://canva.com/)
|
|
- [Bannerbear](https://bannerbear.com/)
|