Skip to content

Commit c27450f

Browse files
authored
docs: Updated README.md for dart define instructions (#153)
1 parent d9aeb69 commit c27450f

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# App name - Flutter
22

33
## 📖 Project description
4+
45
This project serves as a template project for Flutter applications. You can generate a new repository by clicking "Use this template" above.
56

67
## 🔧 Setup and Installation
8+
79
- Execute `$ flutter doctor` to verify installations
810
- Execute `$ pub get` to pull project dependencies
911
- Execute a run configuration of choice
10-
- `$ flutter run --flavor staging -t lib/main_staging.dart`
11-
- `$ flutter run --flavor production -t lib/main_production.dart`
12+
- `$ flutter run --flavor development -t lib/main_development.dart --dart-define-from-file=lib/config/dart_define_keys/dart_define_development_keys.json`
13+
- `$ flutter run --flavor staging -t lib/main_staging.dart --dart-define-from-file=lib/config/dart_define_keys/dart_define_staging_keys.json`
14+
15+
⚠️ **Running the Production Flavor**
16+
17+
It is **not recommended** to run the production flavor directly from the IDE
18+
(VS Code or Android Studio) as it may be run by mistake. For ease and accuracy,
19+
it is advised to run flavors via the **VS Code launch menu** or the **Android
20+
Studio Run menu** instead.
1221

1322
## 🌲 Branches
14-
* `master` - Latest version in the app store.
15-
* `develop` - Default. Feature branches are merged in when complete and then deleted.
23+
24+
- `master` - Latest version in the app store.
25+
- `develop` - Default. Feature branches are merged in when complete and then deleted.
1626

1727
## 🔗 Useful links
28+
1829
- [Jira Board](https://TODO)
1930
- [Confluence](https://TODO)
2031
- [Slack Channel](https://TODO)

0 commit comments

Comments
 (0)