documentation: Update readme.txt

[processor-sdk/big-data-ipc-examples.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..32d8403ce3e1057017c3227acc294a9aa31127f0 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -0,0 +1,34 @@
+#
+#  ======== readme.txt ========
+#
+
+BigdataIPC examples
+
+These examples are created to show case how to share big data buffers
+between cores in a multicore system
+
+host_bios: Examples here assume host running TI RTOS
+
+simple_buffer_example: This example demonstrates simple buffer exchange
+       between cores
+
+
+Build procedure
+==============
+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.