Skip to content

Commit

Permalink
📝 Add dependencies to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
OlivierLDff committed Apr 12, 2021
1 parent d7ba869 commit 4c7afac
Show file tree
Hide file tree
Showing 2 changed files with 308 additions and 2 deletions.
17 changes: 15 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,32 @@ NetTcp provide a Tcp `Server` that create Tcp `Socket` for each incoming connect

A `Socket` can also be used on client side to connect to a remote server.

## Overview
## 🚀 Overview

<p align="center">
<img src="./docs/ClassDiagram.svg"/>
</p>

Checkout the documentation to learn how to use NetTcp:
Checkout the documentation to learn how to use **NetTcp**:

* Learn how to create a [Client](https://olivierldff.github.io/NetTcp/GettingStart.html#create-a-client) and a [Server](https://olivierldff.github.io/NetTcp/GettingStart.html#create-a-server).
* Checkout [Examples](https://olivierldff.github.io/NetTcp/GettingStart.html#examples).
* [Use the library with QML](https://olivierldff.github.io/NetTcp/QmlUsage.html).
* [Build the library](https://olivierldff.github.io/NetTcp/BuildAndRun.html).

## 📌 Dependencies

**NetTcp** relies on:

* Multiple libraries from the Qt framework.
* Qt::Core
* Qt::Network
* Qt::Qml
* **QOlm** to present the **Server** as a list of **Socket**.
* **spdlog** to provide customizable log sink.

![dependencies](./docs/dependencies.svg)

## Authors

* [Olivier Le Doeuff](https://github.com/OlivierLDff)
Loading

0 comments on commit 4c7afac

Please sign in to comment.