[AD-509] Update dev environment setup docs (#6)

* [AD-509] Update mac developer environment setup

* Adjust formatting

* Add note about llvm

* Add note about iodbc

README.md

@@ -19,24 +19,45 @@
 3. [WiX Installer (3.11)](https://wixtoolset.org/releases/)
    1. Ensure to add path to WiX executables (e.g. `C:\Program Files (x86)\WiX Toolset v3.11\bin`)
 4. Java **JDK** (version 8+ - 17 recommended)
-   1. Ensure to set JAVA_HOME
-5. Run one of build scripts to create an initial compilation.
+   1. Ensure to set `JAVA_HOME`. 
+5. Boost Test Framework 
+   1. Install via [VCPKG](https://vcpkg.io/en/getting-started.html) using `.\vcpkg install openssl:x64-windows boost-test:x64-windows boost-asio:x64-windows boost-chrono:x64-windows boost-interprocess:x64-windows boost-regex:x64-windows boost-system:x64-windows boost-thread:x64-windows`
+6. Run one of the build scripts to create an initial compilation.
    1. E.g.: `.\build_win_debug64.ps1`
    2. Navigate to the `build\odbc\cmake` folder to use the generated solution file, `Ignite.C++.sln` to work on
    source code development and testing.
-6. More details in `src\DEVNOTES.txt`.
+7. More details in `src\DEVNOTES.txt`.
 
 ### MacOS
 
-1. Install deppendencies
-   1. brew install cmake
-   2. brew install openssl
-   3. brew install unixodbc
-2. Run one of build scripts to create an initial compilation.
-   1. E.g.: `./buid_mac_release64.sh`
+1. Install dependencies
+   1. `brew install cmake`
+   2. `brew install openssl`
+   3. `brew install unixodbc`  
+      - You may need to unlink `libiodbc` if you already have this installed. Use `brew unlink libiodbc`.
+   4. `brew install boost`
+   5. Install Java **JDK** (version 8+ - 17 recommended)  
+      - This can be done through Homebrew using `brew install --cask temurin<version>`. 
+      - Ensure to set `JAVA_HOME`.  
+   6. If creating a debug build (`./build_mac_debug64.sh`), install LLVM. 
+      - To ensure LLVM and CMake are compatible, use the LLVM included with XCode by modifying the PATH with `export PATH=/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/:$PATH`.
+2. Run one of the build scripts to create an initial compilation.
+   1. E.g.: `./build_mac_release64.sh`
    2. Navigate to the `build/odbc/lib` folder to use the generated files.
-3. Use Microsoft VS Code to work on source code devlopment and testing.
+3. More details in `src\DEVNOTES.txt`.
 
 ### Linux
 
 TBD
+
+### Troubleshooting 
+
+#### Issue: MacOS build fails with error about iODBC header
+##### Example error message  
+```
+/Library/Frameworks/iODBC.framework/Headers/sqlext.h:82:10: fatal error: 'iODBC/sql.h' file not found
+#include <iODBC/sql.h>
+     ^~~~~~~~~~~~~ 
+``` 
+##### Fix 
+If you have installed the iODBC Driver Manager, the headers installed with it might be used instead of those from `unixodbc`. You may need to uninstall this driver manager and remove the `/Library/Frameworks/iODBC.framework/` directory.