-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
29 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ on: | |
workflow_dispatch: | ||
push: | ||
branches: | ||
- docs | ||
- asio | ||
|
||
name: Build doxygen documentation | ||
jobs: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,31 @@ | ||
# Pine | ||
|
||
Pine is a modern and lightweight Windows chat/forum application built with the | ||
[Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/), and | ||
[WinUI3](https://docs.microsoft.com/windows/apps/winui/winui3/). | ||
Pine is a modern and lightweight C++20 library for building chat applications. | ||
|
||
Server side is built on | ||
[WinSocks2](https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-start-page-2). | ||
It uses its own protocol, which is based on TCP using asio. Therefore, it is | ||
not suitable for use on the web. | ||
|
||
It is multi-threaded and uses asynchronous I/O, and is designed to be | ||
easily extensible. | ||
|
||
## Building | ||
|
||
_Build will not work if using clang_ | ||
|
||
It is recommended to use [vcpkg](https://github.com/microsoft/vcpkg) to install | ||
dependencies. Pine uses CMake as its build system. To build Pine, run the | ||
following commands: | ||
|
||
Dependencies: | ||
|
||
```bash | ||
vcpkg install asio:x64-windows gtest:x64-windows | ||
vcpkg install asio:x64-linux gtest:x64-linux | ||
``` | ||
|
||
```bash | ||
mkdir build | ||
cd build | ||
cmake .. -DCMAKE_TOOLCHAIN_FILE=<path to vcpkg>/scripts/buildsystems/vcpkg.cmake | ||
cmake --build . | ||
``` |