distro-manifest-generator: add support for JSON output format

[AGL/meta-agl.git] / scripts / README-mkefi-agl.md

diff --git a/scripts/README-mkefi-agl.md b/scripts/README-mkefi-agl.md
index f415747..2262fb1 100644 (file)
--- a/scripts/README-mkefi-agl.md
+++ b/scripts/README-mkefi-agl.md
@@ -1,16 +1,18 @@
-## Introduction
-This script will install the AGL distribution on a removable device to boot on Intel UEFI-based computer.
-
-In particular it can create a USB or SD bootable support for (MinnowBoard)[www.minnowboard.org].
+# Introduction
 
-Usage:
+This script will install the AGL distribution on a removable device to boot on Intel UEFI-based computer.
 
-    mkefi-agl.sh [-v] HDDIMG REMOVABLE_DEVICE
-       -v: verbose debug
-       HDDIMG: the hddimg file to generate the efi disk from
-       REMOVABLE_DEVICE: the block device to write the image to, e.g. /dev/sdh
+In particular it can create a USB or SD bootable support for [MinnowBoard](www.minnowboard.org).
 
-Example: `mkefi-agl.sh agl-demo-platform-intel-corei7-64.hddimg /dev/sdd`
+Usage: mkefi-agl.sh [-v] IDSK_IMAGE REMOVABLE_DEVICE
+       -v: Verbose debug
+       HDDIMG: The DISK_IMAGE file generated by Yocto the efi disk from
+               Supported formats are .hddimg, .wic .wic.xz
+       REMOVABLE_DEVICE: The block device to write the image to, e.g. /dev/sdh
+ex:
+   mkefi-agl.sh   agl-demo-platform-intel-corei7-64.hddimg /dev/sdd
+   mkefi-agl.sh   agl-demo-platform-intel-corei7-64.wic.xz /dev/sdd
 
 ## Documentation
-Additional documentation: https://wiki.automotivelinux.org/agl-distro/developer_resources_intel
+
+[Additional documentation](https://wiki.automotivelinux.org/agl-distro/developer_resources_intel)