From 43fb32f6aa5a3c89ec577a2fe2af20a4c8c87641 Mon Sep 17 00:00:00 2001 From: Pcornat Date: Sun, 24 Jan 2021 21:11:12 +0100 Subject: [PATCH] README.md integrated --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab0c10d --- /dev/null +++ b/README.md @@ -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.