Pcornat
/
gemini-server
1
0
Fork 0
Code Issues Pull Requests Releases Activity

README.md integrated

This commit is contained in:
Pcornat 2021-01-24 21:11:12 +01:00
parent 497dbd2e26
commit 43fb32f6aa
No known key found for this signature in database
GPG Key ID: 873C3ACCF970C74E
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# A C++ Gemini server
## Introduction
As I saw other implementations in Rust but no C++ to compete, I felt that I had to do something ;-).
It is also a chance for me and a friend (Brumaire) to practice C++ and to try to get as much performance as possible (my speciality is HPC so… Yeah).
## Design
I use PlantUML to do the class diagram for the design. It's a work in progress.
## Goal
What we want is a high performance server using asynchrony within the threads (multi-threading) to have the maximum possible performance.
Also a feature of caching content is a must.
## Configuration
**WIP**
The configuration of the server is made through a JSON file `config.json`. The JSON parser is [simdjson](https://github.com/simdjson/simdjson) directly integrated
in our source code.
## Documentation
The doc of the code is made with [doxygen](https://www.doxygen.nl/), the `Doxyfile` is at the root of the repo.