Fixing broken links and formatting in App Framework page
[AGL/documentation.git] / docs / 0_Getting_Started / 3_Build_and_Boot_guide_Profile / 2_IVI_Flutter_apps.md
1 # Build and Boot AGL Flutter IVI dashboard demo applications made for GSoC
2
3 ## 0. Prepare Your Build Host
4
5 - 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/)
6
7 ## 1. Define Your Top-Level Directory
8
9 ```bash
10 $ export AGL_TOP=$HOME/AGL
11 $ echo 'export AGL_TOP=$HOME/AGL' >> $HOME/.bashrc
12 $ mkdir -p $AGL_TOP
13 ```
14
15 ## 2. Download the repo Tool and Set Permissions
16
17 ```bash
18 $ mkdir -p $HOME/bin
19 $ export PATH=$HOME/bin:$PATH
20 $ echo 'export PATH=$HOME/bin:$PATH' >> $HOME/.bashrc
21 $ curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/bin/repo
22 $ chmod a+x $HOME/bin/repo
23 ```
24
25 ## 3. Download the AGL Source Files
26 To download the latest **master** branch  AGL files, use the following commands:
27 ```bash
28 $ cd $AGL_TOP
29 $ mkdir master
30 $ cd master
31 $ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
32 $ repo sync
33 ```
34
35 ## 4. Initialize the build environment using aglsetup.sh Script
36 To initialize the build environment, we must use the setup script.
37 This script is available here:
38 ```bash
39 $ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh
40 ```
41 Run the script:
42
43 ```bash
44 $ cd $AGL_TOP
45 $ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-dashboard -m qemux86-64 agl-demo agl-devel
46 ```
47
48 - Here `-b` is used to specify the build directory and `-m` is used to specify the target platform.
49
50 - Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/master/build-flutter-dashboard`
51 - Default target paltform: `qemux86-64`
52
53 ## 5. Using BitBake
54
55 ```bash
56 $ cd $AGL_TOP/build-flutter-dashboard
57 $ source agl-init-build-env
58 $ bitbake agl-ivi-demo-platform-flutter
59 ```
60
61 ## 6. Deploying the AGL Demo Image
62 Boot the image using QEMU
63
64 ```bash
65 $ cd $AGL_TOP/build-flutter-dashboard
66 $ source agl-init-build-env
67 $ runqemu kvm serialstdio slirp publicvnc
68 ```
69
70 ## 6. Run the Graphics
71 To get graphics of the app, you need VNC client like VNC Viewer or Vinagre
72
73 - Open the VNC client
74 - Enter the server address as `localhost:0`
75
76 That's it, you should get something like this:
77 ![Screenshot](images/ivi_homescreen.PNG)
78