From 38d13c7702a0b4bfce3ec2bf6172f92176af3650 Mon Sep 17 00:00:00 2001
From: Chuntao Hong <chuntao.hong@gmail.com>
Date: Sat, 12 Sep 2020 10:36:52 +0800
Subject: [PATCH] doc

---
 README.md     | 42 ++++++++++++++++++++++++++++++++++++++++++
 test/Makefile |  2 +-
 2 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a72a01c..5660bef 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,47 @@ Current implementation uses C++14, so you need a new compiler to compile the cod
 
 Tested on both Linux and Windows (Visual Studio 2019).
 
+
+Compiling Test
+=======
+
+test/test.cpp is a simple test demonstrating how to use Remmy. You can compile it with `CMake`, `make`, or `Visual Studio`.
+
+**Compiling With CMake**
+
+To compile with `CMake`, use the following command:
+```bash
+user@myhost:~/projects/Remmy$ mkdir build
+user@myhost:~/projects/Remmy$ cd build
+user@myhost:~/projects/Remmy/build$ cmake .. -DCOMM_LAYER=ASIO
+-- The C compiler identification is GNU 7.4.0
+-- The CXX compiler identification is GNU 7.4.0
+-- ...
+-- Configuring done
+-- Generating done
+-- Build files have been written to: /home/user/projects/Remmy/build
+user@myhost:~/projects/Remmy/build$ make
+Scanning dependencies of target remmy_test
+[ 50%] Building CXX object CMakeFiles/remmy_test.dir/test/test.cpp.o
+[100%] Linking CXX executable remmy_test
+[100%] Built target remmy_test
+```
+
+Note that we use `-DCOMM_LAYER=ASIO` option for `CMake` here. Remmy supports ASIO and ZMQ. Here we choose ASIO as the communication layer.
+
+If you want to use ZeroMQ, you also need to install libzmq.
+
+**Compiling With `make`**
+
+There is a Makefile under `Remmy/test`, which can be used to compile the test. The communication can be switched by defining the `USE_ASIO` or `USE_ZMQ` at the top of the Makefile.
+
+**Building With VS 2017/2019**
+
+`Remmy/remmy.sln` is a VS 2019 solution file. You can use VS 2019 to open the solution and compile the test project. However, if you choose to use VS 2017, you need to retarget the solution before you can build it. To retarget the solution, open it and right-click on the `Solution 'Remmy'` in `Solution Explorer`, then choose `Retarget Solution`. In the pop-up windows, choose `latest installed version` for `Windows SDK Version`.
+
+By default the solution uses ASIO as the communication layer. Switching to ZeroMQ requires defining `USE_ZMQ` and `USE_ASIO` macros in project properties. You will also need to specify the location to ZeroMQ library when using ZeroMQ.
+
+
 Programming interface
 =======
 
@@ -65,6 +106,7 @@ public:
 
 Please refer to [/test/test.cpp](/test/test.cpp) for an example on how to use Remmy.
 
+
 Contributing
 =======
 Everyone is welcome to contribute to this project, either to improve the code or documentation.
diff --git a/test/Makefile b/test/Makefile
index 9f84ce3..f588bd8 100644
--- a/test/Makefile
+++ b/test/Makefile
@@ -13,7 +13,7 @@ ifeq ($(USE_ZMQ), 1)
 	LDFLAGS += -lzmq -L../deps/zmq
 endif
 
-test: test.cpp ../remmy/*.h Makefile
+remmy_test: test.cpp ../remmy/*.h Makefile
 	g++ test.cpp -o test $(CXXFLAGS) $(LDFLAGS)
 
 clean: