From 1eebbee3df99cea42bfb0d31c94faae2c1422678 Mon Sep 17 00:00:00 2001 From: Scott Godin Date: Wed, 8 Jan 2025 14:29:06 -0500 Subject: [PATCH] - add build artifacts to .gitignore - update README.md instructions for windows --- .gitignore | 5 ++--- README.md | 35 +++++++++++++++++++++++------------ 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index 7e96d853a..3503cdd71 100644 --- a/.gitignore +++ b/.gitignore @@ -98,6 +98,5 @@ media/samples/music.h media/samples/playback_prompt.h media/samples/record_prompt.h - - - +/_build +/sipXtapi-prefix diff --git a/README.md b/README.md index 8fcfb7f4b..d21eb17fc 100644 --- a/README.md +++ b/README.md @@ -92,27 +92,38 @@ $ cmake -DBUILD_QPID_PROTON=OFF . ## Building on Windows Systems -### Generating Visual Studio solution and project files +### Using Visual Studio GUI + +Navigate to git root folder where top level CMakeLists.txt file is. +``` +> cmake . +``` +Or to build recon with sipXtapi media support you need to do the following: +``` +> cmake . -DUSE_SIPXTAPI=ON +``` +Or if you plan on using VS GUI you might want to enable the following to get the full sipXtapi projects into the resip solution file: +``` +> cmake . -DUSE_SIPXTAPI=ON -DSIPXTAPI_PROJS_IN_VS_GUI=ON +``` + +* Open resiprocate.sln (from _build folder) in visual studio: Build -> Build Solution +* Note: If you used -DSIPXTAPI_PROJS_IN_VS_GUI=ON then you must build once before the sipXtapi projects are fetched from GitHub. After this reload the resiprocate.sln and build again. This is only needed after initial setting up the build. +* If you want to run the unit tests, then right click on the RUN_TESTS project and Build it. + + +### Using CMake from command line Navigate to git root folder where top level CMakeLists.txt file is. ``` > cmake . -B _build ``` -To build recon with sipXtapi media support you need to do the following: +OR to build recon with sipXtapi media support you need to do the following: ``` > cmake . -B _build -DUSE_SIPXTAPI=ON ``` -Or if you plan on using VS GUI you might want to enable the following to get the full sipXtapi projects into the resip solution file: -``` -> cmake . -B _build -DUSE_SIPXTAPI=ON -DSIPXTAPI_PROJS_IN_VS_GUI=ON -``` -#### Using Visual Studio GUI -* Open resiprocate.sln (from _build folder) in visual studio: Build -> Build Solution -* If you want to run the unit tests, then right click on the RUN_TESTS project and Build it. - -#### Using CMake Command line -Navigate to git root folder where top level CMakeLists.txt file is. +To build navigate to git root folder where top level CMakeLists.txt file is. ``` > cmake --build _build --config Debug --parallel ```