docs(readme): setup readme file #12

Merged
Mineplay merged 5 commits from QN-4 into main 2026-01-22 15:28:27 -06:00
Showing only changes of commit f664ea73e7 - Show all commits

View file

@ -20,6 +20,49 @@ The QNet library offers the following features:
### Prerequisites ### Prerequisites
Ensure you have the following installed on your system:
* CMake (minimum version 3.10)
* A compatible C compiler (e.g., GCC or MSVC)
### Build steps ### Build steps
1. Clone the repository:
```bash
git clone https://repo.strawhats.nl/Mineplay/QNet.git
```
2. Navigate to the directory:
```bash
cd QNet
```
3. Create build directory:
```bash
mkdir build
```
4. Run cmake to configure the project:
```bash
cmake . -B build
```
5. Build the project:
```bash
cmake --build build --config Release
```
To build in debug use:
```bash
cmake --build build
```
This will both generate the library and test files.
## Using the library ## Using the library