Skip to content

Commit

Permalink
Organize docs
Browse files Browse the repository at this point in the history
  • Loading branch information
temeddix committed Sep 12, 2024
1 parent e05cb1f commit b790661
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,5 @@ _Please provide the output from the command below, using markdown codeblock synt
```bash
rustc --version
flutter doctor
dart pub global activate native_doctor
dart pub global run native_doctor
```
8 changes: 7 additions & 1 deletion documentation/docs/installing-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@ To get started, you need to have [Flutter SDK](https://docs.flutter.dev/get-star

[^1]: If you're working on Linux, do not install Flutter from `snap`. Flutter from `snap` comes with its own binary linker called `ld`, which is fundamentally incompatible with Rust. Instead, follow the manual installation method as written in the Flutter docs.

Then, activate some necessary features:

```bash title="CLI"
flutter config --enable-native-assets
dart pub global activate native_doctor
```

Once the installations are complete, verify your system's readiness with the following commands:

```bash title="CLI"
rustc --version
flutter doctor
dart pub global activate native_doctor
dart pub global run native_doctor
```

Expand Down
8 changes: 7 additions & 1 deletion flutter_ffi_plugin/bin/src/helpers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ This project leverages Flutter for GUI and Rust for the backend logic,
utilizing the capabilities of the
[Rinf](https://pub.dev/packages/rinf) framework.
Please activate the necessary features first.
```
flutter config --enable-native-assets
dart pub global activate native_doctor
```
To run and build this app, you need to have
[Flutter SDK](https://docs.flutter.dev/get-started/install)
and [Rust toolchain](https://www.rust-lang.org/tools/install)
Expand All @@ -110,7 +117,6 @@ Note that all the subcomponents should be installed.
```bash
rustc --version
flutter doctor
dart pub global activate native_doctor
dart pub global run native_doctor
```
Expand Down
8 changes: 7 additions & 1 deletion flutter_ffi_plugin/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ This project leverages Flutter for GUI and Rust for the backend logic,
utilizing the capabilities of the
[Rinf](https://pub.dev/packages/rinf) framework.

Please activate the necessary features first.

```
flutter config --enable-native-assets
dart pub global activate native_doctor
```

To run and build this app, you need to have
[Flutter SDK](https://docs.flutter.dev/get-started/install)
and [Rust toolchain](https://www.rust-lang.org/tools/install)
Expand All @@ -18,7 +25,6 @@ Note that all the subcomponents should be installed.
```bash
rustc --version
flutter doctor
dart pub global activate native_doctor
dart pub global run native_doctor
```

Expand Down

0 comments on commit b790661

Please sign in to comment.