Skip to content

Commit 260746d

Browse files
committed
chore: update libvconsole/README.md for v1.3.0
1 parent 7f03ac8 commit 260746d

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

libvconsole/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ libvconsole is a static C++ library that implements the VConsole2 Protocol used
99
- Supported send message types: CMND (TODO investigate: VCFS)
1010
- Callback system for handling incoming messages
1111

12-
## Limitations
13-
- Windows-only for now. Sorry!
14-
1512
## Usage
1613

1714
```cpp
@@ -38,21 +35,22 @@ int main() {
3835

3936
## Building
4037

41-
To build libvconsole, you'll need a C++11 compatible compiler. The library has been tested with MSVC, but should work with other compilers as well.
38+
Requires a C++17 compatible compiler.
39+
40+
### CMake (Recommended)
41+
42+
```bash
43+
mkdir build && cd build
44+
cmake ..
45+
cmake --build .
46+
```
4247

43-
### Windows (MSVC)
48+
### Visual Studio (Windows)
4449

4550
1. Open the libvconsole.vcxproj file in Visual Studio
4651
2. Select your desired configuration (Debug/Release) and platform (x86/x64)
4752
3. Build the project
4853

49-
### Other Platforms
50-
51-
1. Compile the source files in the `src` directory
52-
2. Link against the necessary system libraries (e.g., ws2_32 on Windows)
53-
54-
No Makefiles are provided, so you'll need to set up your own build process if not using MSVC.
55-
5654
## License
5755

5856
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)