Skip to content

Commit de9d770

Browse files
committed
Fix typo, update README
1 parent e3e1c6b commit de9d770

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,5 +147,5 @@ endif()
147147
# Examples
148148

149149
if(STREAMCLIENT_BUILD_EXAMPLES)
150-
add_subdirectory(docs)
150+
add_subdirectory(example)
151151
endif()

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,8 @@ for (auto& t : threads) {
176176

177177
## How to build
178178

179-
This library supposed to be somewhat multi-platform, however, it was tested and mainly used on ubuntu and macOS. Therefore build instructions are given for only these OSes.
179+
This library supposed to be somewhat multi-platform, however, it was tested and mainly used on ubuntu and macOS. </br>
180+
Prefer [out-of-source](https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#what-is-an-out-of-source-build) building.
180181

181182
### Ubuntu dependencies
182183

@@ -191,23 +192,27 @@ sudo apt install build-essential cmake libboost-dev libboost-system-dev libssl-d
191192
brew install cmake pkg-config icu4c openssl boost
192193
```
193194

194-
### Test/Install
195-
196-
Prefer [out-of-source](https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#what-is-an-out-of-source-build) building:
195+
To build:
196+
```bash
197+
cmake -H. -Bbuild
198+
cmake --build ./build
199+
```
197200

201+
To install (sudo may be required):
198202
```bash
199-
mkdir build
200-
cd build
201-
cmake -DCMAKE_BUILD_TYPE=Debug ..
202-
make -j$(nproc)
203-
make test
203+
cmake -H. -Bbuild -DSTREAMCLIENT_BUILD_TESTING=OFF -DSTREAMCLIENT_BUILD_DOCS=OFF -DSTREAMCLIENT_BUILD_EXAMPLES=OFF
204+
cmake --build ./build --target install
204205
```
205206

206-
To install the lib (sudo may be required):
207+
Or test:
207208
```bash
208-
make install
209+
cmake -H. -Bbuild -DSTREAMCLIENT_BUILD_TESTING=ON -DSTREAMCLIENT_BUILD_DOCS=OFF -DSTREAMCLIENT_BUILD_EXAMPLES=OFF
210+
cmake --build ./build
211+
cmake -E chdir ./build ctest --output-on-failure
209212
```
210213

214+
*All these commands assume you are in stream-client root folder*
215+
211216
### Cmake options
212217

213218
* **CMAKE_BUILD_TYPE** - [build type](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html). `RelWithDebInfo` by default.

0 commit comments

Comments
 (0)