diff --git a/README.md b/README.md index f84de10..f922c60 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ # Flutter for Embedded Linux (eLinux) This software is a **non-official** extension to the [Flutter SDK](https://github.com/flutter/flutter) to build Flutter apps for Embedded Linux devices. +**The tool is still been developing! So, there is a lot of unsupported function.** + +## Quick start +### How to insall flutter-elinux +```Shell +$ git clone https://github.com/sony/flutter-elinux.git +$ sudo mv flutter-elinux /opt/ +$ export PATH=$PATH:/opt/flutter-elinux/bin +``` + +### How to run flutter sample app in Weston +```Shell +$ flutter-elinux create sample +$ cd sample +$ weston & +$ flutter-elinux run -d elinux +``` + ## Documentation See https://github.com/sony/flutter-elinux/wiki @@ -10,7 +28,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). ## Companion repos | Repo | Purpose | | ------------- | ------------- | -| [flutter-elinux](https://github.com/sony/flutter-elinux-plugins) | Flutter tools for eLinux | +| [flutter-elinux](https://github.com/sony/flutter-elinux) | Flutter tools for eLinux | | [flutter-elinux-plugins](https://github.com/sony/flutter-elinux-plugins) | Flutter plugins for eLinux | | [flutter-embedded-linux](https://github.com/sony/flutter-embedded-linux) | eLinux embedding for Flutter | | [meta-flutter](https://github.com/sony/meta-flutter) | Yocto recipes of eLinux embedding for Flutter |