Move rmr python api docs over.

[ric-plt/xapp-frame-py.git] / examples / rmr / README.md

diff --git a/examples/rmr/README.md b/examples/rmr/README.md
new file mode 100644 (file)
index 0000000..671c9b1
--- /dev/null
+++ b/examples/rmr/README.md
@@ -0,0 +1,8 @@
+# Tests
+
+First, edit the `local.rt` file with your hostname.
+
+Start the receiver and the tester. Be sure to set `LD_LIBRARY_PATH` or your system equivelent to point to where the RMR .so files are. On my system (Arch Linux) they are as below. Also, `set -x` is fish shell notation, substitute for your shell.
+
+    set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT ./local.rt; python receive.py
+    set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT ./local.rt; python send.py