diff --git a/README.md b/README.md index 5fa17bad1fec9e99d60e06d470970456548e51f1..7781f750ae3a14a0d9c7332e8268903578ec3d4c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,37 @@ -# Template C Project with CMake as build system +# Wordle-de ein wordle Nachbau in C++ -## Configure +## Voraussetzungen + +### Ubuntu + +#### CMake installieren +``` +sudo apt update && sudo apt install cmake +``` + +#### Bibliotheken installieren (Protobuf und Botan) +``` bash +sudo apt update && sudo apt install libbotan-2-dev protobuf-codegen protobuf-compiler +``` + +## Kompilieren mit CodeBlocks + +### Cmake konfigurieren + +Im Terminal, im Verzeichnis wordle-de, folgenden Befehl ausführen: +``` +cmake -B build -G"CodeBlocks - Unix Makefiles" +``` +Anschließend kann das CodeBlocks Projekt unter `build/wordle-de.cbp` geöffnet werden. +Von hier aus können die Applikationen in CodeBlocks bearbeitet und kompiliert werden. +Die beiden Applikationen `wordle-de_server` und `wordle-de_client` können per Terminal (nicht aus CodeBlocks heraus) gestartet werden: +`./build/wordle-de_server` +`./build/wordle-de_client` + +## Kompilieren ohne CodeBlocks + +### Configure `cmake -B build -S . -G "Ninja Multi-Config"` -## Build +### Build `cmake --build build [--config Debug|Release]`