Skip to content

Commit

Permalink
Formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
leoafarias committed Jun 9, 2024
1 parent e478718 commit 607d47e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
16 changes: 10 additions & 6 deletions docs/pages/documentation/guides/running-flutter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You are able to proxy any `flutter` or `dart` commands to the configured version

<Callout type="info">

Configure the following alias for a shorthand version of the command
Configure the following alias for a shorthand version of the command:

```bash
# aliases
Expand All @@ -54,7 +54,7 @@ f run

### Routing

When proxying commands, `FVM` will look for an SDK in the following order.
When proxying commands, `FVM` will look for an SDK in the following order:

1. Project
2. Ancestor directory
Expand All @@ -74,7 +74,7 @@ Using the symlink will dynamically call the configured version for the project.

<Callout type="info">

Configure the following alias to call the relative project version, without the need to proxy.
Configure the following alias to call the relative project version, without the need to proxy:

```bash
fv=".fvm/flutter_sdk/bin/flutter"
Expand All @@ -84,7 +84,7 @@ fv=".fvm/flutter_sdk/bin/flutter"

<Callout type="info">

If you wish to reroute `flutter` and `dart` calls to FVM i.e. ensure that running `flutter` on the terminal internally runs `fvm flutter` then you could run the below commands.
If you wish to reroute `flutter` and `dart` calls to FVM, i.e., ensure that running `flutter` on the terminal internally runs `fvm flutter`, then you could run the below commands.

**On Mac**

Expand All @@ -99,21 +99,25 @@ sudo echo 'fvm dart ${@:1}' > "/usr/local/bin/dart" && sudo chmod +x /usr/local/
echo 'fvm flutter ${@:1}' > "$HOME/.local/bin/flutter" && chmod +x "$HOME/.local/bin/flutter"
echo 'fvm dart ${@:1}' > "$HOME/.local/bin/dart" && chmod +x "$HOME/.local/bin/dart"
```
If you've installed flutter/dart using native package managers, the binaries might conflict with these new shortcuts so consider deleting the existing ones and taking a backup for easier restoration.

If you've installed flutter/dart using native package managers, the binaries might conflict with these new shortcuts, so consider deleting the existing ones and taking a backup for easier restoration.

If you wish to remove these reroutes, just delete the corresponding files as shown below:

**On Mac**

```bash
sudo rm /usr/local/bin/flutter
sudo rm /usr/local/bin/dart
```

**On Linux**

```bash
rm "$HOME/.local/bin/flutter"
rm "$HOME/.local/bin/dart"
```

</Callout>

## Spawn Command
Expand All @@ -126,7 +130,7 @@ fvm spawn {version}

## Examples

The following will run `flutter analyze` on the `master` channel
The following will run `flutter analyze` on the `master` channel:

```bash
fvm spawn master analyze
Expand Down
29 changes: 14 additions & 15 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import MainHeading from "../components/MainHeading";
<Spacer />
<Link href="https://pub.dev/packages/fvm">
<img alt="Pub Likes" src="https://img.shields.io/pub/likes/fvm?style=for-the-badge&logo=flutter&logoColor=%2358CDFA&label=Pub%20Likes&labelColor=white&color=%2358CDFA"/>

</Link>
<Spacer />
<Link href="https://github.com/leoafarias/fvm/graphs/contributors">
Expand All @@ -24,16 +23,16 @@ import MainHeading from "../components/MainHeading";
</div>
---

FVM streamlines Flutter version management. It allows per project SDK versions, ensuring consistent app builds and easier testing of new releases, thereby boosting the efficiency of your Flutter project tasks.
FVM streamlines Flutter version management. It allows per-project SDK versions, ensuring consistent app builds and easier testing of new releases, thereby boosting the efficiency of your Flutter project tasks.

## Why FVM?

- Need for simultaneous use of multiple Flutter SDKs.
- SDK testing requires constant [channel](https://github.com/flutter/flutter/wiki/Flutter-build-release-channels) switching.
- Channel switches are slow and need repeated reinstalls.
- Difficulty managing the latest successful SDK version used in an app.
- Flutter's major updates demand total app migration.
- Inconsistencies occur in development environments within teams.
- Need for simultaneous use of multiple Flutter SDKs.
- SDK testing requires constant [channel](https://github.com/flutter/flutter/wiki/Flutter-build-release-channels) switching.
- Channel switches are slow and need repeated reinstalls.
- Difficulty managing the latest successful SDK version used in an app.
- Flutter's major updates demand total app migration.
- Inconsistencies occur in development environments within teams.

## Contributors

Expand All @@ -49,15 +48,15 @@ Their invaluable participation helps us develop and manage Flutter versions more

## Principles

- Interact with the SDK only through Flutter tools.
- Avoid overriding any Flutter CLI commands.
- Adhere to Flutter's recommended installation procedures for effective caching.
- Aim to enhance Flutter's behavior, not to alter it.
- Prioritize a simple and intuitive API.
- Interact with the SDK only through Flutter tools.
- Avoid overriding any Flutter CLI commands.
- Adhere to Flutter's recommended installation procedures for effective caching.
- Aim to enhance Flutter's behavior, not to alter it.
- Prioritize a simple and intuitive API.

## Video Guides & Walkthroughs

You can view a playlist of many Youtube guides & walkthroughs done by the incredible Flutter community in many different languages.
You can view a playlist of many YouTube guides & walkthroughs done by the incredible Flutter community in many different languages.

<iframe
width="560"
Expand All @@ -67,4 +66,4 @@ You can view a playlist of many Youtube guides & walkthroughs done by the incred
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>
></iframe>

0 comments on commit 607d47e

Please sign in to comment.