added build instructions

esbmc · Jun 25, 2024 · 65b107e · 65b107e
1 parent d908012
commit 65b107e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -9,7 +9,7 @@ project(CInstrumentation)
 #################################
 
 # Demand C++17
-set (CMAKE_CXX_STANDARD 23)
+set (CMAKE_CXX_STANDARD 20)
 
 # Adds custom modules from ESBMC and default Options
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/scripts/cmake/")

diff --git a/README.md b/README.md
@@ -1,6 +1,19 @@
 # C-instrumentator
 A C instrumentation library
 
+# Building
+
+## Ubuntu
+
+Install dependencies: `sudo apt-get install clang llvm clang-tidy  git linux-libc-dev libclang-dev libclang-cpp-dev cmake build-essential`
+Configure: `mkdir build && cd build && cmake .. -DBUILD_TESTING=1 -DClang_DIR=/usr/lib/cmake/clang-14 -DLLVM_DIR=/usr/lib/llvm-14/lib/cmake/llvm`
+Build: `make -j4`
+
+## macOS
+
+Install dependencies: `brew install llvm@16`
+Configure: `mkdir build && cd build && cmake .. -DBUILD_TESTING=1 -DLLVM_DIR=/opt/homebrew/opt/llvm@14 -DClang_DIR=/opt/homebrew/opt/llvm@14`
+Build: `make -j4`
 
 # Project Structure