Skip to content

Commit 2286edf

Browse files
authored
Update README.md
1 parent 4049b5c commit 2286edf

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

client/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# websocket client
2+
3+
Simple example of the websocket client. Built with oat++ (AKA oatpp) web framework.
4+
5+
See more:
6+
7+
- [Oat++ Website](https://oatpp.io/)
8+
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
9+
- [Get Started With Oat++](https://oatpp.io/docs/start)
10+
11+
## Overview
12+
13+
### Project layout
14+
15+
```
16+
|- CMakeLists.txt // projects CMakeLists.txt
17+
|- src/
18+
| |
19+
| |- WSListener.hpp // WebSocket listeners are defined here
20+
| |- App.cpp // main() is here
21+
|
22+
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
23+
```
24+
25+
## Build and Run
26+
27+
### Using CMake
28+
29+
**Requires:** [oatpp](https://github.com/oatpp/oatpp), and [oatpp-websocket](https://github.com/oatpp/oatpp-websocket)
30+
modules installed. You may run `utility/install-oatpp-modules.sh`
31+
script to install required oatpp modules.
32+
33+
After all dependencies satisfied:
34+
35+
```
36+
$ mkdir build && cd build
37+
$ cmake ..
38+
$ make
39+
$ ./websocket-client-exe # - run application.
40+
```
41+

0 commit comments

Comments
 (0)