readme: Add readme.txt for build and test instructions
authorSam Nelson <sam.nelson@ti.com>
Tue, 1 Aug 2017 03:18:44 +0000 (23:18 -0400)
committerSam Nelson <sam.nelson@ti.com>
Tue, 1 Aug 2017 03:18:44 +0000 (23:18 -0400)
Signed-off-by: Sam Nelson <sam.nelson@ti.com>
readme.txt [new file with mode: 0644]

diff --git a/readme.txt b/readme.txt
new file mode 100644 (file)
index 0000000..a334bc0
--- /dev/null
@@ -0,0 +1,26 @@
+The rpmsg_proto_socket_test application sends and receives packets through
+the rpmsg_proto socket interface.
+
+The application sends first a short init_msg followed by a full size message.
+
+Then the applicaiton waits for a recieve message. Once received the content is
+ to checked to see if the looped back message matches with sent packet and
+ prints success or failure accordingly.
+(Note any looped back init(short) message is ignored.)
+
+To compile
+----------
+
+Set cross compile as follows
+export CROSS_COMPILE=arm-linux-gnueabihf-
+export ARCH=arm
+PATH=$HOME/gcc-linaro-5.3-2016.02-x86_64_arm-linux-gnueabihf/bin:$PATH
+
+Then just execute make at the root directory
+
+The executable binary "rpmsg_proto_socket_test" will be created at the root directory itself.
+
+To run
+------
+
+Copy the executable "rpmsg_proto_socket_test" to the filsystem and execute.