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
Copy file name to clipboardExpand all lines: docs/Architecture.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
# Architecture
2
2
3
-
This file document the different directory of this project.
4
-
Each section will contain explanation and a directory tree.
3
+
This file documents the different directories of this project.
4
+
Each section will contain explanations and a corresponding directory tree.
5
5
6
6
## Flutter
7
7
8
8
### Dependencies and generated files
9
9
10
10
The `.fvmrc` is used by [fvm](https://fvm.app/) to specify the flutter version.
11
-
`lib/`contain the flutter code.
12
-
`pubspec.lock` is a lock file to handle dependencies.
13
-
`pubspec.yaml` is configuration file specifying :
11
+
`lib/`contains the flutter code.
12
+
`pubspec.lock` is a lock file to handle dependency versions.
13
+
`pubspec.yaml` is a configuration file that specifies :
14
14
15
15
- the app version
16
16
- the flutter sdk requirement
17
-
- the dependencies
18
-
- the asset directory
17
+
- the project dependencies
18
+
- the assets directory
19
19
20
20
```
21
21
├── .fvmrc
@@ -26,8 +26,8 @@ The `.fvmrc` is used by [fvm](https://fvm.app/) to specify the flutter version.
26
26
27
27
### Flutter code
28
28
29
-
Contain the flutter code that make the app.
30
-
Follow a view-model structure where `components` contain reusable parts.
29
+
This directory contains the flutter code that builds the app.
30
+
This project follows a view-model structure where `components` contain reusable UI parts.
31
31
32
32
```sh
33
33
.
@@ -45,8 +45,8 @@ Follow a view-model structure where `components` contain reusable parts.
45
45
46
46
## Android
47
47
48
-
The android directory contain all elements necessary to target Android, most of it is gradle configuration.
49
-
Upgrading the `AGP (Android Gradle Plugin)` open the `android` directory with Android Studio and use **Tools > AGP Upgrade Assitant** or manually update the gradle configuration at your own risk.
48
+
The android directory contain all elements needed to build the app for Android, primarily Gradle configurations.
49
+
to upgrade the `AGP (Android Gradle Plugin)` open the `android` directory with Android Studio and use **Tools > AGP Upgrade Assitant** or manually update the Gradle configuration files (at your own risk).
50
50
51
51
```
52
52
.
@@ -60,9 +60,9 @@ Upgrading the `AGP (Android Gradle Plugin)` open the `android` directory with An
60
60
61
61
## Translations
62
62
63
-
Translations are hosted on [crowdin](https://crowdin.com/project/piwigo-ng), everything is translated from english.
64
-
Flutter take the `app_%%.arb` files and generate dart code inside the `lib/l10n` directory.
65
-
`untranslated.json` is generated at compile time to indicate missing string.
63
+
Translations are managed on [crowdin](https://crowdin.com/project/piwigo-ng), with all translations based on English.
64
+
Flutter processes the `app_%%.arb` files and generate Dart code in the `lib/l10n` directory.
65
+
An `untranslated.json` is generated at compile time to indicate any missing translations.
66
66
67
67
```sh
68
68
# %% = country code, one file per translation
@@ -78,4 +78,4 @@ Flutter take the `app_%%.arb` files and generate dart code inside the `lib/l10n`
0 commit comments