forked from jsnbuchanan/crowd-funder-for-time-pwa
2d17bfd3b4
- Update BUILDING.md with current build system information - Modernize various README files across the project - Update CHANGELOG.md with recent changes - Improve documentation consistency and formatting - Update platform-specific documentation (iOS, Electron, Docker) - Enhance test documentation and build guides
83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
# TimeSafari Resources Directory
|
|
|
|
This directory contains source assets for the TimeSafari application across all platforms.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
resources/
|
|
├── android/
|
|
│ ├── icon/
|
|
│ │ └── icon.png
|
|
│ └── splash/
|
|
│ ├── splash.png
|
|
│ └── splash_dark.png
|
|
├── ios/
|
|
│ ├── icon/
|
|
│ │ └── icon.png
|
|
│ └── splash/
|
|
│ ├── splash.png
|
|
│ └── splash_dark.png
|
|
└── web/
|
|
├── icon/
|
|
│ └── icon.png
|
|
└── images/
|
|
```
|
|
|
|
## Asset Requirements
|
|
|
|
### Icon Requirements
|
|
|
|
- **Format**: PNG
|
|
- **Size**: 1024x1024 pixels minimum
|
|
- **Background**: Transparent or solid color
|
|
- **Content**: App logo/icon
|
|
|
|
### Splash Screen Requirements
|
|
|
|
- **Format**: PNG
|
|
- **Size**: 1242x2688 pixels (iPhone 11 Pro Max size)
|
|
- **Background**: Solid color or gradient
|
|
- **Content**: App logo centered
|
|
|
|
## Asset Generation
|
|
|
|
Assets are automatically generated during the build process using `capacitor-assets`:
|
|
|
|
```bash
|
|
# Generate assets for all platforms
|
|
npx capacitor-assets generate
|
|
|
|
# Generate assets for specific platform
|
|
npx capacitor-assets generate --ios
|
|
npx capacitor-assets generate --android
|
|
npx capacitor-assets generate --web
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Asset generation is configured in `capacitor-assets.config.json` at the project root.
|
|
|
|
## Version Control
|
|
|
|
- **Source assets** (this directory): ✅ In version control
|
|
- **Generated assets**: ❌ Not in version control (excluded by `.gitignore`)
|
|
|
|
## Updating Assets
|
|
|
|
1. Replace the source asset files in the appropriate platform directory
|
|
2. Run the build process to regenerate platform-specific assets
|
|
3. Test the generated assets on target platforms
|
|
|
|
## Build Integration
|
|
|
|
Assets are automatically generated as part of the build process:
|
|
|
|
- `npm run build:android` - Generates Android assets
|
|
- `npm run build:ios` - Generates iOS assets
|
|
- `npm run build:web` - Generates web assets
|
|
|
|
**Author**: Matthew Raymer
|
|
**Date**: 2025-01-27
|
|
**Status**: ✅ **ACTIVE** - Asset management system implemented
|