Readme file update.
This commit is contained in:
parent
cf12bcb001
commit
1c7d0a6018
32
README.md
32
README.md
@ -0,0 +1,32 @@
|
||||
# Isspam
|
||||
Fast as light evaluator for text files to summarize specific details about the text files.
|
||||
|
||||
## Building
|
||||
```
|
||||
make build
|
||||
```
|
||||
## Running
|
||||
### Using files as parameter
|
||||
```
|
||||
./isspam ./spam/*.txt
|
||||
./isspam ./not_spam/*.txt
|
||||
```
|
||||
### Using stdin
|
||||
Useful for automation.
|
||||
```
|
||||
cat ./spam/example_spam1.txt | ./isspam
|
||||
```
|
||||
## Valgrind status
|
||||
Date: 2024-11-28
|
||||
```
|
||||
Memory usage: 1 MB, 6.460 (re)allocated, 4.222 unqiue free'd, 0 in use.
|
||||
==131498==
|
||||
==131498== HEAP SUMMARY:
|
||||
==131498== in use at exit: 0 bytes in 0 blocks
|
||||
==131498== total heap usage: 6,486 allocs, 6,486 frees, 2,342,294 bytes allocated
|
||||
==131498==
|
||||
==131498== All heap blocks were freed -- no leaks are possible
|
||||
==131498==
|
||||
==131498== For lists of detected and suppressed errors, rerun with: -s
|
||||
==131498== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
|
||||
```
|
Loading…
Reference in New Issue
Block a user