Bulk documentation updates for needlefish

[AGL/documentation.git] / docs / 0_Getting_Started / 1_Quickstart / Using_Ready_Made_Images.md

diff --git a/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md b/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md
index 7bbc957..9b1258c 100644 (file)
--- a/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md
+++ b/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md
@@ -8,9 +8,9 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 1. QEMU (Emulation)
 
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz).
 
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/bzImage).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemux86-64/deploy/images/qemux86-64/bzImage).
 
 3. Install [QEMU](https://www.qemu.org/download/) :
 
@@ -44,7 +44,7 @@ AGL provides a number of pre-built ready-made images of various versions.
 
   ```sh
     $ ( sleep 5 && vinagre --vnc-scale localhost ) > /tmp/vinagre.log 2>&1 &
-      qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \
+    $ qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \
       -drive file=agl-demo-platform-crosssdk-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \
       -snapshot -vga virtio \
       -vnc :0 -soundhw hda -machine q35 -cpu kvm64 -cpu qemu64,+ssse3,+sse4.1,+sse4.2,+popcnt -enable-kvm \
@@ -75,7 +75,10 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 2. Virtual Box (Emulation)
 
-  1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz).
+**NOTE :** Please note [https://www.virtualbox.org/ticket/19873](https://www.virtualbox.org/ticket/19873) as this affects the VMs resolution.
+The AGL demo images do require 1920x1080. The instructions below have been adapted.
+
+  1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz).
 
   2. Install and set up [Virtual Box](https://www.virtualbox.org/wiki/Linux_Downloads).
 
@@ -96,14 +99,18 @@ AGL provides a number of pre-built ready-made images of various versions.
     - Go to `Storage`, and change the attribute to `Type : AHCI` and click on `OK`.
     ![vbox-step-5](images/vbox-5.png)
     - Next go to `Display` and change the attribute to 'VMSVGA' for the graphics driver. Change the graphics memory to be at least 64MB.
-    - Click on `Start`.
+    - **Important:**: Open a new terminal window and execute this command:
+    ```sh
+    VBoxManage setextradata agl-demo VBoxInternal2/EfiGraphicsResolution 1920x1080
+    ```
+    - Return to the UI and click on `Start`.
     - For troubleshooting, you can refer [here](https://lists.automotivelinux.org/g/agl-dev-community/message/8474).
 
 ### 3. x86 physical system
 
   **NOTE :** UEFI enabled system is required.
 
-  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz).
+  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz).
 
   2. Extract the image into USB drive :
 
@@ -121,9 +128,9 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 1. QEMU (Emulation)
 
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz).
 
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/zImage).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemuarm/deploy/images/qemuarm/zImage).
 
 3. Install [QEMU](https://www.qemu.org/download/) :
 
@@ -192,7 +199,7 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 2. BeagleBone Enhanced (BBE)
 
-  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/bbe/deploy/images/bbe/agl-demo-platform-crosssdk-bbe.wic.xz).
+  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/bbe/deploy/images/bbe/agl-demo-platform-crosssdk-bbe.wic.xz).
 
   2. Extract the image into the SD card of BeagleBone Enhanced :
 
@@ -217,9 +224,9 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 1. QEMU (Emulation)
 
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz).
 
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/Image).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/needlefish/latest/qemuarm64/deploy/images/qemuarm64/Image).
 
 3. Install [QEMU](https://www.qemu.org/download/) :
 
@@ -288,7 +295,7 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 2. Raspberry Pi 4
 
-  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz).
+  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz).
 
   2. Extract the image into the SD card of Raspberry Pi 4 :
 
@@ -353,19 +360,19 @@ AGL provides a number of pre-built ready-made images of various versions.
 
 ### 3. R-Car H3SK (H3ULCB board)
 
-**NOTE :** The prebuilt image doesn't support graphics (as of yet) and will run headless. For graphical support, a local build with the neccesary graphics driver is required.
+**NOTE :** The prebuilt image does support **non-accelerated** graphics mode (software rendering). For **accelerated** graphics support, a local build with the neccesary graphics driver is required.
 
 
-  1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/).
+  1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/release/needlefish/latest/h3ulcb-nogfx/deploy/images/h3ulcb/).
 
-  2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-image-ivi-crosssdk-h3ulcb.wic.xz).
+  2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/needlefish/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-demo-platform-crosssdk-h3ulcb.wic.xz).
 
   3. Extract the image into the boot device :
 
      ```sh
      $ lsblk
      $ sudo umount <boot_device_name>
-     $ xzcat agl-image-ivi-crosssdk-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M
+     $ xzcat agl-demo-platform-crosssdk-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M
      $ sync
      ```