From 2d8c707d063589f476b8ca8bc2e68f11724b3a6a Mon Sep 17 00:00:00 2001 From: retoor Date: Sat, 30 Nov 2024 22:08:28 +0100 Subject: [PATCH] Updated readme. --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 394d7dc..3a72508 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,31 @@ # Isspam -Fast as light evaluator for text files to summarize specific details about the text files. +Fast as light evaluator for text files to summarize specific details about the text files. +This repository contains two versions of the same algorithm. +Versions: + - Rust (risspam) written by 12bitfloat. + - C (isspam) written by retoor. ## Building ``` make build ``` -Build with memory check (requires valgrind to be installed): +Build isspam with memory check (requires valgrind to be installed): ``` make valgrind ``` ## Running ### Using files as parameter ``` -./isspam ./spam/*.txt -./isspam ./not_spam/*.txt +./(r)isspam ./spam/*.txt +./(r)isspam ./not_spam/*.txt ``` ### Using stdin -Useful for automation. +Useful for automation. Works only on the isspam version. ``` cat ./spam/example_spam1.txt | ./isspam ``` ## Example output +Output example made by isspam. ``` File: ./spam/example_spam3.txt Capitalized words: 39 @@ -47,6 +52,7 @@ Word count per sentence: 21 Memory usage: 1 MB, 6.460 (re)allocated, 4.222 unqiue free'd, 0 in use. ``` ## Valgrind status +Valgrind output for isspam version. Rust variant thinks it's too cool for memory checks afterwards. Date: 2024-11-30 ``` ==58062==