Updated readme.
Some checks failed
isspam build / build (push) Failing after 1m18s
Details

Browse Source
This commit is contained in:
retoor 2024-11-30 22:08:28 +01:00
parent 4aaca6a998
commit 2d8c707d06
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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==