Skip to content

Commit 598276d

Browse files
committed
Add Image Format Guidelines to README.md
1 parent ef2eb32 commit 598276d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
Find study spaces at the University of Michigan, Ann Arbor
44

5+
## Image Format Guidelines
6+
7+
### File Format Requirement
8+
9+
All images in `images/buildings/` and `images/areas` must be JPEG files.
10+
11+
### Image Size Recommendations
12+
13+
* `images/buildings/*.jpeg` needs to be at least 200x200px
14+
* `images/areas/*.jpeg` needs to be at least 600x400px
15+
16+
### Aspect Ratio Recommendations
17+
18+
* `images/buildings/*.jpeg` needs an aspect ratio of 1:1 (square)
19+
* `images/areas/*.jpeg` needs an aspect ratio of 1.5:1 (width is 1.5 times longer than height)
20+
21+
If an image does not meet the above recommended aspect ratios, they will be scaled and cropped dynamically.
22+
523
## Generate Image Assets
624

725
Run the `generate_images.sh` to convert jpeg images in `images/` folder to webp images.
@@ -30,6 +48,7 @@ of icons packaged:
3048
2. Reference this guide for more details: https://medium.com/codechai/how-to-use-custom-icons-in-flutter-834a079d977
3149

3250
## Generate App Name
51+
3352
Run `./generate_app_name.sh` to generate new app names for Android, iOS, and Web.
3453

3554
## Generate App and Web Icons Locally

0 commit comments

Comments
 (0)