kapitan/IXWebSocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deployed fa0408e with MkDocs version: 1.1.2

Browse Source
This commit is contained in:
2020-10-08 19:44:07 +00:00
parent 5d11fd38c8
commit e2d346e9dd
11 changed files with 50 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
build/index.html
View File

@ -114,7 +114,6 @@ cmake -DUSE_TLS=1 ..
make -j
make install # will install to /usr/local on Unix, on macOS it is a good idea to sudo chown -R `whoami`:staff /usr/local
</code></pre>
<p>Headers and a static library will be installed to the target dir.
There is a unittest which can be executed by typing <code>make test</code>.</p>
<p>Options for building:</p>
@ -135,14 +134,12 @@ There is a unittest which can be executed by typing <code>make test</code>.</p>
...
)
</code></pre>
<h3 id="vcpkg">vcpkg</h3>
<p>It is possible to get IXWebSocket through Microsoft <a href="https://github.com/microsoft/vcpkg">vcpkg</a>.</p>
<pre><code>vcpkg install ixwebsocket
</code></pre>
<p>To use the installed package within a cmake project, use the following:</p>
<pre><code class="cmake"> set(CMAKE_TOOLCHAIN_FILE &quot;$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake&quot; CACHE STRING &quot;&quot;) # this is super important in order for cmake to include the vcpkg search/lib paths!
<pre><code class="language-cmake"> set(CMAKE_TOOLCHAIN_FILE &quot;$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake&quot; CACHE STRING &quot;&quot;) # this is super important in order for cmake to include the vcpkg search/lib paths!
# find library and its headers
find_path(IXWEBSOCKET_INCLUDE_DIR ixwebsocket/IXWebSocket.h)
@ -153,7 +150,6 @@ There is a unittest which can be executed by typing <code>make test</code>.</p>
target_link_libraries(${PROJECT_NAME} ... ${IXWEBSOCKET_LIBRARY}) # Cmake will automatically fail the generation if the lib was not found, i.e is set to NOTFOUNS
</code></pre>
<h3 id="conan">Conan</h3>
<p><a href="https://bintray.com/conan/conan-center/ixwebsocket%3A_/_latestVersion"> <img alt="Download" src="https://api.bintray.com/packages/conan/conan-center/ixwebsocket%3A_/images/download.svg" /> </a></p>
<p>Conan is currently supported through a recipe in <a href="https://github.com/conan-io/conan-center-index/tree/master/recipes/ixwebsocket">Conan Center</a> (<a href="https://bintray.com/conan/conan-center/ixwebsocket%3A_">Bintray entry</a>).</p>
@ -167,7 +163,6 @@ There is a unittest which can be executed by typing <code>make test</code>.</p>
<p>There is a Dockerfile for running the unittest on Linux, and to run the <code>ws</code> tool. It is also available on the docker registry.</p>
<pre><code>docker run docker.pkg.github.com/machinezone/ixwebsocket/ws:latest --help
</code></pre>
<p>To use docker-compose you must make a docker container first.</p>
<pre><code>$ make docker
...