From e667051a81e6391137f7e4d794c92f71c296c026 Mon Sep 17 00:00:00 2001 From: raj_mathe Date: Sun, 10 Apr 2022 15:59:37 +0200 Subject: [PATCH] master > master: code-rust - README --- code/rust/README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/code/rust/README.md b/code/rust/README.md index 7eaefdf..0abf052 100644 --- a/code/rust/README.md +++ b/code/rust/README.md @@ -1,3 +1,45 @@ # ADS2 - Implementierung in Rust # -(_Noch nicht implementiert_) +Im Ordner [./src/*](src/) findet Module mit Datenstrukturen und Algorithmen. + +Im Ordner [./test/*](test/) findet man _unit tests_, +die die verschiedenen Datenstrukturen und Algorithmen mit Testfälle belasten. +Man kann auch direkt im Code von [./src/main.rs](src/main.rs) aus +die Methoden mit Daten ausprobieren. + +## Voraussetzungen ## + +1. Der Rust-Compiler wird benötigt und + hierfür ist der **cargo** Package-Manager zu empfehlen. + Siehe für die offizielle Anleitung. +2. Es ist auch empfehlenswert, **make** zu installieren. + - Linux/OSX: siehe . + - Windows: siehe . + +## Build -> Test -> Run ## + +Navigiere im IDE zum [rust](/)-Ordner in deinem IDE. +Öffne eine bash-Konsole und führe folgende Befehle aus: + +Wer **make** hat: +```bash +# zum Kompilieren (nur nach Änderungen nötig): +make build; +# zur Ausführung der unit tests: +make tests; +# zur Ausführung des Programms +make run; +# zur Bereinigung aller Artefakte +make clean; +``` +Wer _kein_ make hat: +```bash +# zum Kompilieren (nur nach Änderungen nötig): +cargo build --release; +# zur Ausführung der unit tests: +cargo test; +# zur Ausführung des Programms +dist/ads2 # oder den gebauten Artefakt mit Maus doppelklicken +``` +Der `build` Schritt baut einen binären Artefekt +und kopiert dies nach dem [./dist/*](dist/) Ordner.