summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2022-04-28 20:11:13 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2022-04-28 20:11:13 +0100
commitfd13b16ba823bcd7b6f9c7163e7e75585855d33f (patch)
tree15496a2f336488f90810dbdf6f343441aff6135e /README.md
parentd5c63e2ed3a5feaaa51e9cb315e6c0601ae01813 (diff)
downloadSmarker-fd13b16ba823bcd7b6f9c7163e7e75585855d33f.tar.gz
Smarker-fd13b16ba823bcd7b6f9c7163e7e75585855d33f.zip
Updated readme and docs
Diffstat (limited to 'README.md')
l---------README.md24
1 files changed, 24 insertions, 0 deletions
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