From 91c4ecf3c484ac1dd1e228c6a534f7def45b31b9 Mon Sep 17 00:00:00 2001 From: sfja Date: Wed, 18 Dec 2024 01:50:23 +0100 Subject: [PATCH] explain in readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 06e37bb..b54705f 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,38 @@ > > af en sådan art eller beskaffenhed som lige er eller vil blive antydet, nævnt eller omtalt ofte om noget foragtet eller ubehageligt[^[1]]() +A tool for developing high quality software. + +Project includes: the slige-programming language, a compiler for slige, a runtime environment, a graphical fontend for code analysis + +## Devtool + +### Source code viewer + +View program source code with syntax highlighting. + +![](docs/source_code_page.png) + +### Code coverage + +View what parts of the program are executed what amount of times. + +Includes 2 modes: +- **Performance view**: Used to locate *hot* sections in the program. The more *hot*, ie. the more times a section is executed, the more critical the section is for overall performance. +- **Test view**: Used to locate sections, that are not covered by tests. Automated tests are ineffective, if sections of the tested code, are not covered, ie. are never executed. + +![](docs/code_coverage_page_test_view.png) + +![](docs/code_coverage_tooltip_1.png) + +![](docs/code_coverage_tooltip_2.png) + +### Flame graph + +A flame graph displays what functions' individual execution time make up the overall execution time. + +![](docs/flame_graph_page.png) + +![](docs/flame_graph_tooltip.png) + +