diff --git a/README.md b/README.md index 887c7d7..ade7600 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +# Repozitorija apraksts + +Direktorijā `src` atrodas pirmkods, kas ir sadalīts 3 moduļos `transpiler`, +`qtapp` un `test`. Transpilātora modulis veic transpilēšanu, kuru kā API +izmanto lietotnes modulis `qtapp`, kas izmanto `qt` un `QScintilla` bibliotēku. +Modulis `test` satur automatizētos testus; izmanto `GTest` bibliotēku. + # Nepieciešamie rīki un bibliotēkas ## Linux @@ -73,3 +80,15 @@ Darbam uz Windows direktorijā papildus jāieliek `qscintilla2_qt5.dll` un Piegādes kompilēšanā var pielikt `-DWIN32_EXECUTABLE=ON`, lai slēdzot programmu nerādītos termināla logs. + +# Testu izpilde + +Ja testi tiek kompilēti, tie tiek uzbūvēti "tests" direktorijā. Tos jāpalaiž +terminālī. Nefunkcionālos testus ir lietderīgi palaist `Release` konfigurācijā, +jo tās veiktspēja ir ievērojami augstāka un precīzāk atbilst gala lietotāja +iegūtai veiktspējai. + +``` +./src/test/transpilerFunctional +./src/test/transpilerNonFunctional ../src/test/testFiles/ +```