diff --git a/README.md b/README.md index 6809ce4bc8d6e4d2a5c49c8418d4d3fb3b2817fd..f98ec96dde899671d3cbb1d4944f2f78e4d20253 100644 --- a/README.md +++ b/README.md @@ -17,35 +17,43 @@ Vor jeder Anfrage wird die Eingabe optional auf **syntaktische Korrektheit** und --- -## **Voraussetzungen** -- Python **3.10** oder höher (Du kannst Python [hier herunterladen](https://www.python.org/)) -- Installation und Nutzung über das Terminal ---- - ## **Installation** 1. **Terminal öffnen:** - Öffne dein Terminal und navigiere zu dem Ordner, in welchem du das Tool ablegen möchtest. -2. **Ollama installieren:** - Installiere Ollama, um das Llama3-Modell lokal auszuführen: + Starten Sie ein Terminalfenster auf Ihrem System und führen Sie die folgenden Schritte aus. + +2. **Python installieren:** + Installieren Sie Python 3.10 oder höher über die offizielle [Python-Website](https://www.python.org/) und überprüfen Sie die Installation anschließend mit dem Befehl: + ```bash + python --version + ``` + +3. **Git installieren:** + Installieren Sie Git 2.40.1 oder höher über die offizielle [Git-Website](https://git-scm.com/) und überprüfen Sie die Installation anschließend mit dem Befehl: + ```bash + git --version + ``` + +4. **Ollama installieren:** + Installieren Sie Ollama 0.4.2 oder höher über die offizielle [Ollama-Website](https://ollama.com/) und überprüfen Sie die Installation anschließend mit dem Befehl: ```bash - pip install ollama + ollama --version ``` -3. **Llama3-Modell laden:** - Lade das Modell lokal herunter: +5. **Llama3-Modell laden:** + Laden Sie das Llama 3.1-Modell mit Ollama herunter: ```bash ollama pull llama3.1:8b ``` -4. **Repository klonen:** - Lade das Projekt herunter: +6. **Repository klonen:** + Klonen Sie das Repository des Testskriptgenerators: ```bash - git clone https://git-st.inf.tu-dresden.de/ag-feedbacksysteme/student-projects/ba-yorick-behme.git + git clone https://git-st.inf.tu-dresden.de/ag-feedbacksysteme/student-projects/ba-yorick-behme/ ``` -5. **Ins Code-Verzeichnis wechseln:** +7. **Ins Code-Verzeichnis wechseln:** Navigiere in das Hauptverzeichnis des Projekts: ```bash - cd ba-yorick-behme/src + cd ArTEMiS-Testgenerator/src ``` -5. **Programm starten:** +8. **Programm starten:** Führe die Anwendung aus: ```bash python3 main.py @@ -56,16 +64,6 @@ Vor jeder Anfrage wird die Eingabe optional auf **syntaktische Korrektheit** und ## **Projektstruktur** ```plaintext -├── appx/ -│ ├── artemis_integration.md -│ ├── beispiel_optimierung.md -│ ├── feedback_nutzerbefragung.md -│ ├── modelfileuntersuchung.md -│ ├── modellauswertung.md -│ ├── modelluntersuchung.md -│ ├── modellvergleich.md -│ ├── poc_nutzerbefragung.md -│ └── promptuntersuchung.md ├── src/ │ ├── generator_manager.py │ ├── main.py