Skip to content

Commit 7a842b2

Browse files
authored
Improve phrasing/wording in Architecture.md
Improve phrasing/wording
1 parent 7e49fb8 commit 7a842b2

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

docs/Architecture.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Architecture
22

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.
55

66
## Flutter
77

88
### Dependencies and generated files
99

1010
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 :
1414

1515
- the app version
1616
- the flutter sdk requirement
17-
- the dependencies
18-
- the asset directory
17+
- the project dependencies
18+
- the assets directory
1919

2020
```
2121
├── .fvmrc
@@ -26,8 +26,8 @@ The `.fvmrc` is used by [fvm](https://fvm.app/) to specify the flutter version.
2626

2727
### Flutter code
2828

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.
3131

3232
```sh
3333
.
@@ -45,8 +45,8 @@ Follow a view-model structure where `components` contain reusable parts.
4545

4646
## Android
4747

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).
5050

5151
```
5252
.
@@ -60,9 +60,9 @@ Upgrading the `AGP (Android Gradle Plugin)` open the `android` directory with An
6060

6161
## Translations
6262

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.
6666

6767
```sh
6868
# %% = country code, one file per translation
@@ -78,4 +78,4 @@ Flutter take the `app_%%.arb` files and generate dart code inside the `lib/l10n`
7878
├── app_localizations.dart
7979
├── app_localizations_en.dart
8080
└── app_localizations_%%.dart
81-
```
81+
```

0 commit comments

Comments
 (0)