From 8bb5dc5e6636a10f2a46f2331615d8cb867d33b8 Mon Sep 17 00:00:00 2001
From: Zaiming Shi <zmstone@gmail.com>
Date: Mon, 14 Dec 2020 00:18:56 +0100
Subject: [PATCH] chore(build): Add examples of how to run test cases in README

---
 Makefile  |  5 +++++
 README.md | 25 +++++++++++++++++++++++--
 2 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index 537117597..6edd45e57 100644
--- a/Makefile
+++ b/Makefile
@@ -22,6 +22,11 @@ ensure-rebar3:
 
 $(REBAR): ensure-rebar3
 
+.PHONY: eunit
+eunit: $(REBAR)
+	$(REBAR) eunit
+
+.PHONY: ct
 ct: $(REBAR)
 	$(REBAR) ct
 
diff --git a/README.md b/README.md
index e1b2f8215..a7603ab8d 100644
--- a/README.md
+++ b/README.md
@@ -55,12 +55,15 @@ For earlier versions, release has to be built from another repo.
 git clone https://github.com/emqx/emqx-rel.git
 cd emqx-rel
 make
-_build/emqx/rel/emqx/bin console
+_build/emqx/rel/emqx/bin/emqx console
 ```
 
 ## Quick Start
 
-```
+If emqx is built from source, `cd _buid/emqx/rel/emqx`.
+Or change to the installation root directory if emqx is installed from a release package.
+
+```bash
 # Start emqx
 ./bin/emqx start
 
@@ -73,6 +76,24 @@ _build/emqx/rel/emqx/bin console
 
 To view the dashboard after running, use your browser to open: http://localhost:18083
 
+## Test
+
+### To test everything in one go
+
+```
+make eunit ct
+```
+
+### To run subset of the common tests
+
+examples
+
+```bash
+./rebar3 ct --dir test,apps/emqx_sn,apps/emqx_coap
+./rebar3 ct --suite test/emqx_SUITE.erl,apps/emqx_auth_http/test/emqx_auth_http_SUITE.erl
+./rebar3 ct --suite test/emqx_SUITE.erl --testcase t_restart
+```
+
 ## FAQ
 
 Visiting [EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html) to get help of common problems.