From 28cd5e9f5ef4b088c396dbec8555123be46dd476 Mon Sep 17 00:00:00 2001
From: Mohit Singh <30595867+qmohitsingh@users.noreply.github.com>
Date: Thu, 23 Nov 2023 16:16:51 -0500
Subject: [PATCH] docs:add compilation guide for apple clang++ (Issue #317)
 (#325)

---
 docs/apple_clang++_compilation_guide.md | 68 +++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 docs/apple_clang++_compilation_guide.md

diff --git a/docs/apple_clang++_compilation_guide.md b/docs/apple_clang++_compilation_guide.md
new file mode 100644
index 000000000..f9d7ef670
--- /dev/null
+++ b/docs/apple_clang++_compilation_guide.md
@@ -0,0 +1,68 @@
+
+# Building from Sources with Clang 16 on macOS
+
+This guide provides instructions on how to build from sources using Clang 16 on a macOS system.
+
+## 1. Install Clang 16
+
+Clang is part of the LLVM project and can be installed on macOS using Homebrew, a popular package manager.
+
+First, ensure you have Homebrew installed. If not, install Homebrew by running the following in the Terminal:
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+Then, install LLVM (which includes Clang) with:
+
+```bash
+brew install llvm@16
+```
+
+## 2. Prepare Build Directory
+
+Clone the desired repository and set up the build environment:
+
+```bash
+git clone https://github.com/cieslarmichal/faker-cxx.git
+cd faker-cxx
+git submodule update --init --recursive
+mkdir build
+cd build
+```
+
+## 3. CMake Setup with Clang 16
+
+Before proceeding, ensure CMake is installed. If not, install it using Homebrew:
+
+```bash
+brew install cmake
+```
+
+Then, set up CMake for building with Clang 16:
+
+```bash
+cmake .. -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm@16/bin/clang++
+```
+
+⚠️ **Warning:** Ensure that the path `/opt/homebrew/opt/llvm@16/bin/clang++` is valid on your system. If this path is not correct, replace it with the correct path to your Clang 16 compiler. You can find the correct path by using the command `brew --prefix llvm@16`. Adjust the CMake command accordingly.
+
+## 4. Build
+
+Finally, build the project:
+
+```bash
+make
+```
+
+## 5. Run
+
+After building, you can run the built executable:
+
+```bash
+./faker-cxx-UT
+```
+
+---
+
+**Note:** This guide assumes a standard installation of Homebrew and the default paths it uses. If your Homebrew or LLVM installation paths are different, you will need to adjust the commands accordingly. Remember that paths and specific commands might vary depending on your system configuration and the versions of the tools installed.