README: Reword and re-style Getting Started section (#1256)

This commit is contained in:
ix5
2024-04-02 22:53:11 +02:00
committed by GitHub
parent b1bf652880
commit dafdf8e130
+10 -8
View File
@@ -98,15 +98,17 @@ For more information on the LocalSend Protocol, see the [documentation](https://
To compile LocalSend from the source code, follow these steps:
1. Install [Flutter](https://flutter.dev).
2. Clone the LocalSend repository.
3. Run `cd app` to enter the app directory.
4. Run `flutter pub get` to download dependencies.
5. Run `flutter run` to start the app.
1. Install Flutter [directly](https://flutter.dev) or using [fvm](https://fvm.app) (see [version required](.fvm/fvm_config.json))
2. Clone the `LocalSend` repository
3. Run `cd app` to enter the app directory
4. Run `flutter pub get` to download dependencies
5. Run `flutter run` to start the app
The issue may be caused by a mismatch between the required Flutter version and the installed Flutter version.
LocalSend uses [fvm](https://fvm.app) to manage the project Flutter version (specified in [.fvm/fvm_config.json](.fvm/fvm_config.json)). After you install it, run `fvm flutter` instead of `flutter`.
> [!NOTE]
> LocalSend currently requires an older Flutter version (specified in [.fvm/fvm_config.json](.fvm/fvm_config.json))
> and thus build issues may be caused by a mismatch between the required and the (system-wide) installed Flutter version.
> To make development more consistent, LocalSend uses [fvm](https://fvm.app) to manage the project Flutter version.
> After installing `fvm`, run `fvm flutter` instead of `flutter`.
## Contributing