From ee5a0a1f7c0a2b715ea9d4dd3c07f2089d851526 Mon Sep 17 00:00:00 2001 From: Wasin Thonkaew Date: Sat, 12 Dec 2015 21:39:34 +0700 Subject: [PATCH] Update README.md Included steps to build and run the project. There might be some frictions for those that don't know the project also utilizes EasyLayout as a submodule, and also it needs to open as workspace project via Xcode too. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 5399575..4220a9d 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,17 @@ Converting the RSSI values to distances was a matter of trial and error. I also Supposedly, different bluetooth devices are going to have varying signal strengths, but the smattering of iOS devices we measured reported the same values. +## How to test the project + +The project uses `EasyLayout` as a submodule. Thus we need to grab its sourcecode first before we can build and test the project. +Follow the following steps. + +1. Clone the project via `git clone `. The link can be find on github page. +2. Execute `cd Easylayout`. +3. Execute `git submodule init`. +4. Execute `git submodule update`. +5. Open `Vicinity.xcworkspace`. Please note it's a workspace project. +6. Build and run the project normally. ## Conclusion