You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 2, 2024. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+4-5
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
12
12
Or download signed binaries for **all mainstream platforms** in the [Releases](https://github.com/tsinis/colors_ai/releases) section of this repository.
13
13
14
-
# Colors AI 🤖
14
+
# Colors AI 🎨🤖
15
15
16
16
## Table of content
17
17
@@ -20,7 +20,6 @@ Or download signed binaries for **all mainstream platforms** in the [Releases](h
20
20
*[Architecture](#Architecture)
21
21
*[Directory Structure](#Directory-Structure)
22
22
*[Tests](#Tests)
23
-
*[Packages](#Packages)
24
23
*[Accessibility](#Accessibility)
25
24
*[How to run it](#How-to-run-it)
26
25
*[UI/UX Design](#UI/UX-Design)
@@ -49,21 +48,22 @@ Application is **partially covered with Unit, Widget, and Integration tests**. M
49
48
50
49
## Accessibility
51
50
52
-
The app was originally designed to be accessible by **WCAG 2.1 AA standards at minimum, and AAA in particular**, although it was not intended to be used by the blind or by people with severe visual disabilities. All **texts have a contrast ratio at least of 4.5, images 3.0, touch target sizes of at least 48dp**. The application was audited physically on a first-generation iPhone SE (smallest iPhone at this moment) with maximum font size, thickness, contrast, and component magnification. The **audit was also performed on the macOS** version of the app, using the same Accessibility Inspector as on the iOS. The **report from the official Accessibility Scanner for Android** (with a tested device with screen size 640x320px and maximum UI and font scale) can be found at [resources/accessibility](./resources/accessibility/) folder. As you may see it will only complain about the small tap size of text links in the *About* app section and overall screen semantics (which is a [framework bug](https://github.com/flutter/flutter/issues/39531)). Also, the application is **translated into 4 languages and have a haptic feedback (vibration) on mobile devices**. The UI was also built to be **controllable via keyboard/input device/remote control/gamepad**, [here you will find a remote control showcase video](https://drive.google.com/file/d/15Ppuk3ELnP6MhUP6smwmrOS-LdbF0ji0/view?usp=sharing).
51
+
The app was originally designed to be accessible by **WCAG 2.1 AA standards at minimum, and AAA in particular**, although it was not intended to be used by the blind or by people with severe visual disabilities. All **texts have a contrast ratio at least of 4.5, images 3.0, touch target sizes of at least 48dp**. The application was audited physically on a first-generation iPhone SE (smallest iPhone at this moment) with maximum font size, thickness, contrast, and component magnification. The **audit was also performed on the macOS** version of the app, using the same Accessibility Inspector as on the iOS. The **report from the official Accessibility Scanner for Android** (with a tested device with screen size 640x320px and maximum UI and font scale) can be found at [resources/accessibility](./resources/accessibility/) folder. As you may see it will only complain about the small tap size of text links in the *About* app section and overall screen semantics (which is a [framework bug](https://github.com/flutter/flutter/issues/39531)). Also, the application is **translated into 4 languages, have a haptic feedback (vibration) on mobile devices and sound feedback on all platforms** (expect PCs at this moment of time). The UI was also built to be **controllable via keyboard/input device/remote control/gamepad**, [here you will find a remote control showcase video](https://drive.google.com/file/d/15Ppuk3ELnP6MhUP6smwmrOS-LdbF0ji0/view?usp=sharing).
53
52
However, in the future, I'm planning to improve the control via the input device.
54
53
55
54
## How to run it
56
55
57
56
Flutter version **2.6.0-12.0.pre.94** or higher is assumed to be installed. Please run this command from the project's folder, in your terminal:
58
57
59
58
```bash
59
+
flutter pub get
60
60
flutter gen-l10n
61
61
flutter run
62
62
```
63
63
64
64
## UI/UX Design
65
65
66
-
All animations here are made with pure Flutter. The application's UI is designed with "gesture-first" UX on mobile platforms and strictly following [Material Design Guidelines](https://material.io/design). Neutral grey color UI is used here to not disrupt user's color perception with highly contrasting light or dark themes.
66
+
All animations here are made with pure Flutter. The application's UI is designed with "gesture-first" UX on mobile platforms and strictly following [Material Design 3 (Material You) Guidelines](https://m3.material.io). Neutral grey color UI is used here to not disrupt user's color perception with highly contrasting light or dark themes.
67
67
68
68
## To-Do Section
69
69
@@ -75,7 +75,6 @@ All animations here are made with pure Flutter. The application's UI is designed
75
75
*[x] L10N.
76
76
*[ ] Add more keyboard shortcuts.
77
77
*[ ] Add Feedback.
78
-
*[ ] Map BLoC events to state via Freezed.
79
78
*[ ] Provide support for Favorites backup (online?).
0 commit comments