Add quick start (#1)

This commit is contained in:
Hidenori Matsubayashi
2021-07-16 16:41:02 +09:00
committed by GitHub
parent eeb28eab23
commit 533e3f3809
+19 -1
View File
@@ -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 |