aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorhritikchouhan <hritikc3961@gmail.com>2022-09-24 02:54:23 -0700
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2022-09-26 15:22:01 +0000
commit7b8af5d3cc5847670caad132173782c98fc03d87 (patch)
tree2554f5e92bb7e5d9b2230ff83fcb7872b5f54dc8 /docs
parent0a3b4ca17dd1eeab7f15cdfb590656377c996501 (diff)
Add documentation for Flutter IVI dashboard applications
This will add documentation to build and boot the agl-ivi-demo-platform-flutter homescreen using QEMU. Change-Id: Ieee92c3cdb0c7598f5df64ebe9d4c705c46e7e20 Signed-off-by: hritikchouhan <hritikc3961@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28029 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_IVI_Flutter_apps.md78
-rw-r--r--docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNGbin0 -> 930228 bytes
2 files changed, 78 insertions, 0 deletions
diff --git a/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_IVI_Flutter_apps.md b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_IVI_Flutter_apps.md
new file mode 100644
index 0000000..6475365
--- /dev/null
+++ b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_IVI_Flutter_apps.md
@@ -0,0 +1,78 @@
+# Build and Boot AGL Flutter IVI dashboard demo applications made for GSoC
+
+## 0. Prepare Your Build Host
+
+- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host/)
+
+## 1. Define Your Top-Level Directory
+
+```bash
+$ export AGL_TOP=$HOME/AGL
+$ echo 'export AGL_TOP=$HOME/AGL' >> $HOME/.bashrc
+$ mkdir -p $AGL_TOP
+```
+
+## 2. Download the repo Tool and Set Permissions
+
+```bash
+$ mkdir -p $HOME/bin
+$ export PATH=$HOME/bin:$PATH
+$ echo 'export PATH=$HOME/bin:$PATH' >> $HOME/.bashrc
+$ curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/bin/repo
+$ chmod a+x $HOME/bin/repo
+```
+
+## 3. Download the AGL Source Files
+To download the latest **master** branch AGL files, use the following commands:
+```bash
+$ cd $AGL_TOP
+$ mkdir master
+$ cd master
+$ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
+$ repo sync
+```
+
+## 4. Initialize the build environment using aglsetup.sh Script
+To initialize the build environment, we must use the setup script.
+This script is available here:
+```bash
+$ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh
+```
+Run the script:
+
+```bash
+$ cd $AGL_TOP
+$ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-dashboard -m qemux86-64 agl-demo agl-devel
+```
+
+- Here `-b` is used to specify the build directory and `-m` is used to specify the target platform.
+
+- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/master/build-flutter-dashboard`
+- Default target paltform: `qemux86-64`
+
+## 5. Using BitBake
+
+```bash
+$ cd $AGL_TOP/build-flutter-dashboard
+$ source agl-init-build-env
+$ bitbake agl-ivi-demo-platform-flutter
+```
+
+## 6. Deploying the AGL Demo Image
+Boot the image using QEMU
+
+```bash
+$ cd $AGL_TOP/build-flutter-dashboard
+$ source agl-init-build-env
+$ runqemu kvm serialstdio slirp publicvnc
+```
+
+## 6. Run the Graphics
+To get graphics of the app, you need VNC client like VNC Viewer or Vinagre
+
+- Open the VNC client
+- Enter the server address as `localhost:0`
+
+That's it, you should get something like this:
+![Screenshot](images/ivi_homescreen.PNG)
+
diff --git a/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG
new file mode 100644
index 0000000..8fa63e0
--- /dev/null
+++ b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG
Binary files differ