documentation: Update readme.txt
authorSam Nelson <sam.nelson@ti.com>
Mon, 20 Mar 2017 18:02:06 +0000 (14:02 -0400)
committerSam Nelson <sam.nelson@ti.com>
Mon, 20 Mar 2017 18:02:06 +0000 (14:02 -0400)
Updated readme.txt with build procedures

Signed-off-by: Sam Nelson <sam.nelson@ti.com>
host_bios/simple_buffer_example/readme.txt
readme.txt

index 5f90ca6c1a68963bec0160a7dc420557be15dedc..49a0cd3b5b532599929317887281affda98f697f 100644 (file)
@@ -34,10 +34,21 @@ Then the host receives back the remaining returned messages before shutting
 
 Build_procedure
 ---------------
-Build is structured to be initiated from the Processor SDK top level makefile.
-
 If you want to override the components or do a local build, then the product.mak
 need to be modified to supply the path names of the different components.
+or
+The following commandline can be used to build the example
+with the appropriate paths set:
+
+PLATFORM=<platform_name> \
+XDC_INSTALL_DIR="<xdc_install_dir>" \
+BIOS_INSTALL_DIR="<bios_install_dir>" \
+IPC_INSTALL_DIR="<ipc_install_dir>" \
+PDK_INSTALL_DIR="<pdk_install_dir>" \
+gnu.targets.arm.A15F="<A15_tools_dir>" \
+ti.targets.elf.C66="<c66_tools_dir>"\
+BOARD_NAME="<board_name>" \
+make
 
 The host binaries are expected to be at:
 host/bin/<board_name>/release
index 294a159f4fe7f85332edd4ddc229704fc0bfcc88..32d8403ce3e1057017c3227acc294a9aa31127f0 100644 (file)
@@ -15,4 +15,20 @@ simple_buffer_example: This example demonstrates simple buffer exchange
 
 Build procedure
 ==============
-These examples are designed to be build from the top level makefile
+The following commandline can be used to build the example
+with the appropriate paths set from the top directory.
+
+PLATFORM=<platform_name> \
+XDC_INSTALL_DIR="<xdc_install_dir>" \
+BIOS_INSTALL_DIR="<bios_install_dir>" \
+IPC_INSTALL_DIR="<ipc_install_dir>" \
+PDK_INSTALL_DIR="<pdk_install_dir>" \
+gnu.targets.arm.A15F="<A15_tools_dir>" \
+ti.targets.elf.C66="<c66_tools_dir>"\
+BOARD_NAME="<board_name>" \
+make host_bios
+
+or
+The corresponding example products.mak can be updated with the paths
+for the various components and the individual examples can be built
+separately.