From c24529b04d603b32aa9540ce8a1fa8b350275db8 Mon Sep 17 00:00:00 2001 From: Irfan Date: Thu, 15 Jun 2017 11:22:49 +0530 Subject: [PATCH 1/2] Update README for linux cmake instructions * Included additional cmake variable examples --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 15cf3dc..5032199 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,28 @@ Building -------- On Linux: - -**TODO**: deb and rpm packages - - ./configure +``` + mkdir ./build && cd build + cmake .. make - sudo make install +``` +You may need to pass some variables to cmake that tells it about the dependencies etc. This may not be necessary if you install the dependencies system wide. Here's an example: +``` +cmake -DLIBNICE_LIBRARY=./libnice.so -DUSRSCTP_LIBRARY=./libusrsctp.so -DLIBNICE_INCLUDE_DIR="./libnice/nice/;./libnice/agent/;./libnice/;" -DUSRSCTP_INCLUDE_DIR=./usrsctp/usrsctplib -DSPDLOG_INCLUDE_DIR="./spdlog/include/" -DDISABLE_SPDLOG=off -DCMAKE_BUILD_TYPE=Debug + ``` + Disable spdlog by passing `-DDISABLE_SPDLOG=on` + +**TODO**: deb and rpm packages On Mac: **TODO**: homebrew integration - +``` brew install ... ./configure make sudo make install - +``` On Windows: From 43f9e971a0fe85bdf43e008ac429bf768f207e43 Mon Sep 17 00:00:00 2001 From: Irfan Date: Thu, 15 Jun 2017 11:36:48 +0530 Subject: [PATCH 2/2] [Formatting] Make markdown headings for OS --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5032199..15d874f 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Dependencies Building -------- -On Linux: +### Linux: ``` mkdir ./build && cd build cmake .. @@ -38,7 +38,7 @@ cmake -DLIBNICE_LIBRARY=./libnice.so -DUSRSCTP_LIBRARY=./libusrsctp.so -DLIBNICE **TODO**: deb and rpm packages -On Mac: +### Mac: **TODO**: homebrew integration ``` @@ -48,7 +48,7 @@ On Mac: sudo make install ``` -On Windows: +### Windows: **TODO**: Visual studio integration, or a script like that jsoncpp library does