diff --git a/README.md b/README.md index 9c7bcda86cb4c58c2e682f21175afdf42c1bb830..0039da307d1adfe7fe4f061aeb8b76a4692f8a6b 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,9 @@ Sjekk av kodekvalitet gjøres med scriptet "CodeQualityCheck" i script-mappa, og Terminal kjøres fra root: -* Sjekk alle .py: `scripts/CodeQualityCheck.ps1` eller `scripts/CodeQualityCheck.sh` +* Sjekk alle .py: `.\scripts\CodeQualityCheck.ps1` eller `./scripts/CodeQualityCheck.sh` -* Sekk spesifikk(e) .py: `scripts/CodeQualityCheck.ps1 filEn.py filTo.py` +* Sekk spesifikk(e) .py: `.\scripts\CodeQualityCheck.ps1 filEn.py filTo.py` ## Testing @@ -44,3 +44,11 @@ Tester er skrevet med `unittest` modulen, og ligger i mappen `test`. * For å kjøre alle tester: `python -m unittest` * For å kjøre en enkelt test modul (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>` * For å kjøre en enkelt test metode (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>.<navnet til klassen>.<navnet til metoden>` + +## Generering av kodedokumentasjon + +Gjøres med pdoc3: + +* `pdoc3 --html --output-dir .\docs .\soitool\main.py` + +* Uten kildekode: `pdoc3 --html --config show_source_code=False --output-dir .\docs\ .\soitool\main.py` \ No newline at end of file