Skip to content

Commit

Permalink
adding a couple more descriptions, and moving the 'make check" step t…
Browse files Browse the repository at this point in the history
…o the top as its necessary to get through that before you can run things.
  • Loading branch information
jvaleski authored Mar 15, 2024
1 parent b3efb5d commit ec7089f
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,23 @@ dependency injection and predictable testing of API integrations.
above.
* See [`location_search_page_test.dart`](weather_app/test/location_search/location_search_page_test.dart) for an example test
with API integration.
* See [`main.dart`](weather_app/lib/main.dart) for the main app scaffolding.
* See [`app_pages`](weather_app/lib/app_pages/) for the UI.

## Dev Environment setup

* Install [Flutter](https://flutter.dev/)
* Install [Android Studio](https://developer.android.com/studio) with Flutter and Dart plugins
* Install [XCode](https://developer.apple.com/xcode/) for iOS dev

## Running checks

This checks formatting, runs tests and checks for dependency cycles

```
make check
```

## Running the app

### On Android Emulator
Expand All @@ -49,14 +59,6 @@ dependency injection and predictable testing of API integrations.
* Select in Android Studio's device list
* Run `main.dart`

## Running checks

This checks formatting, runs tests and checks for dependency cycles

```
make check
```

### Formatting

We use a line length of `100` characters, which is good enough to show two files side by side on a modern 27 inch
Expand Down

0 comments on commit ec7089f

Please sign in to comment.