Skip to content

Commit

Permalink
doc: update flutter doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vivianjeng committed Nov 26, 2024
1 parent 8a5a756 commit 3bf9c40
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 40 deletions.
24 changes: 4 additions & 20 deletions docs/docs/getting-started/flutter-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,17 @@
After completing the [Rust setup](rust-setup.md) and setting up either [iOS setup](ios-setup.md) or [Android setup](android-setup.md), you're ready to create a cross-platform project using [Flutter](https://flutter.dev/). <br/>
Flutter is a framework for building natively compiled, multi-platform applications from a single codebase.

## Flutter plugin example
## Flutter app example

You can now clone the repository from [zkmopro/flutter-plugin](https://github.com/zkmopro/flutter-plugin) with
You can now clone the repository from [zkmopro/flutter-app](https://github.com/zkmopro/flutter-app) with

```sh
git clone https://github.com/zkmopro/flutter-plugin
git clone https://github.com/zkmopro/flutter-app
```

Once cloned, follow the instructions in the README file to run the example app for the plugin.
Once cloned, follow the instructions in the README file to run the example app.

<div style={{ display: 'flex', justifyContent: 'center', gap: '10px' }}>
<img src="/img/flutter-android.png" alt="First Image" width="250"/>
<img src="/img/flutter-ios.png" alt="Second Image" width="250"/>
</div>

## Use the flutter plugin

To use the plugin, update your `pubspec.yaml` file by adding the following dependency:

```yml
dependencies:
mopro_flutter:
# When depending on this package from a real application you should use:
# mopro_flutter: ^x.y.z
# See https://dart.dev/tools/pub/dependencies#version-constraints
# The example app is bundled with the plugin so we use a path dependency on
# the parent directory to use the current plugin's version.
path: <THE_PATH_TO_MOPRO_PLUGIN>
# e.g. path: ../flutter-plugin
```
Binary file modified docs/static/img/flutter-android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/flutter-ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 4 additions & 20 deletions docs/versioned_docs/version-0.1.0/getting-started/flutter-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,17 @@
After completing the [Rust setup](rust-setup.md) and setting up either [iOS setup](ios-setup.md) or [Android setup](android-setup.md), you're ready to create a cross-platform project using [Flutter](https://flutter.dev/). <br/>
Flutter is a framework for building natively compiled, multi-platform applications from a single codebase.

## Flutter plugin example
## Flutter app example

You can now clone the repository from [zkmopro/flutter-plugin](https://github.com/zkmopro/flutter-plugin) with
You can now clone the repository from [zkmopro/flutter-app](https://github.com/zkmopro/flutter-app) with

```sh
git clone https://github.com/zkmopro/flutter-plugin
git clone https://github.com/zkmopro/flutter-app
```

Once cloned, follow the instructions in the README file to run the example app for the plugin.
Once cloned, follow the instructions in the README file to run the example app.

<div style={{ display: 'flex', justifyContent: 'center', gap: '10px' }}>
<img src="/img/flutter-android.png" alt="First Image" width="250"/>
<img src="/img/flutter-ios.png" alt="Second Image" width="250"/>
</div>

## Use the flutter plugin

To use the plugin, update your `pubspec.yaml` file by adding the following dependency:

```yml
dependencies:
mopro_flutter:
# When depending on this package from a real application you should use:
# mopro_flutter: ^x.y.z
# See https://dart.dev/tools/pub/dependencies#version-constraints
# The example app is bundled with the plugin so we use a path dependency on
# the parent directory to use the current plugin's version.
path: <THE_PATH_TO_MOPRO_PLUGIN>
# e.g. path: ../flutter-plugin
```

0 comments on commit 3bf9c40

Please sign in to comment.