From fd13b16ba823bcd7b6f9c7163e7e75585855d33f Mon Sep 17 00:00:00 2001 From: jwansek Date: Thu, 28 Apr 2022 20:11:13 +0100 Subject: Updated readme and docs --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a9ab9e3..e7f7c9c 120000 --- a/README.md +++ b/README.md @@ -6,3 +6,27 @@ formats. - [Read the documentation](http://smarker.eda.gay/) - [Get the source code](https://github.com/jwansek/Smarker) - [Mirror](https://git.eda.gay/Smarker/files.html) + +### Features + +- Analyse code and get results as pdf, json, yaml, markdown, or plaintext +- Analyse code outputs and check for regexes +- Test functions and methods +- Generate plagarism reports +- Isolate code in a docker container for security + +![Function Analysis](https://smarker.eda.gay/_static/readme_functionanalysis.png) + +Function Analysis + +![Runtime Analysis](https://smarker.eda.gay/_static/readme_runtimeanalysis.png) + +Runtime Analysis + +![File with an exception](https://smarker.eda.gay/_static/readme_error.png) + +File with an exception + +![pytest](https://smarker.eda.gay/_static/pytest_error.png) + +Using pytest -- cgit v1.2.3