Skip to content

Commit 320a24d

Browse files
committed
update README
1 parent 459173d commit 320a24d

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,26 +92,21 @@ Two specific points to expand on:
9292

9393
### Setting up
9494

95-
1. Follow the [Flutter installation guide](https://docs.flutter.dev/get-started/install)
96-
for your platform of choice.
97-
2. Switch to the latest version of Flutter by running `flutter channel main`
98-
and `flutter upgrade` (see [Flutter version](#flutter-version) below).
95+
1. Install direnv (TBA), and set up its hook.
96+
2. Make sure you have initialized submodules by doing (do
97+
not do `--depth=1` as flutter relies on tags to know its version):
98+
99+
```sh
100+
git submodule update --init
101+
```
99102
3. Ensure Flutter is correctly configured by running `flutter doctor`.
100103
4. Start the app with `flutter run`, or from your IDE.
101104

102105

103106
### Flutter version
104107

105-
While in the beta phase, we use the latest Flutter from Flutter's
106-
main branch. Use `flutter channel main` and `flutter upgrade`.
107-
108-
We don't pin a specific version, because Flutter itself doesn't offer
109-
a way to do so. So far that hasn't been a problem. When it becomes one,
110-
we'll figure it out; there are several tools for this in the Flutter
111-
community. See [issue #15][].
112-
113-
[issue #15]: https://github.com/zulip/zulip-flutter/issues/15
114-
108+
We pin to a particular version of flutter SDK via git submodules in [vendor/flutter/](vendor/flutter/).
109+
If your local checkout of this repository does not have this submodule checked out at the same commit, the build may fail.
115110

116111
### Tests
117112

@@ -248,7 +243,8 @@ To update the version bounds:
248243
* Run `flutter pub get`, which will update `pubspec.lock`.
249244
* Make a quick check that things work: `tools/check`,
250245
and do a quick smoke-test of the app.
251-
* Commit and push the changes in `pubspec.yaml` and `pubspec.lock`.
246+
* Commit and push the changes in the submodule `vendor/flutter`,
247+
`pubspec.yaml` and `pubspec.lock`.
252248

253249

254250
### Upgrading dependencies

0 commit comments

Comments
 (0)