Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
dam5s committed Aug 13, 2023
1 parent 7cefaa9 commit bb152cf
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Some of the code is useful for desktop apps too.
This is an example of a simple mobile app with API integration and how to set it up with some
dependency injection and predictable testing of API integrations.

* See [`AppDependencies`](weather_app/lib/app_dependencies.dart) for some simple dependency injection using
* See [`AppDependencies`](weather_app/lib/app_dependencies/app_dependencies.dart) for some simple dependency injection using
a [Provider](https://pub.dev/packages/provider).
* See [`TestDepdendencies`](weather_app/test/test_dependencies.dart) for injection of test dependencies.
* See [`result.dart`](weather_app/lib/prelude/result.dart) for functional handling of errors.
Expand Down Expand Up @@ -67,11 +67,20 @@ make format
```

If your prefer a different line length, feel free to update the `Makefile` to your team's liking
and have developers configure Android Studio as well.
and have developers configure their IDE as well.

## Checking for cyclic dependencies

Make sure your imports are relative only for files in the same folder, otherwise use `package:` imports.
Run the make task for checking cycles:

```
make check-cycles
```

## Check before push

To check formatting and run tests before pushing your code
To check formatting, cyclic dependencies and run tests before pushing your code

```
make check
Expand Down

0 comments on commit bb152cf

Please sign in to comment.