Update makefile and README
Some checks failed
isspam build / build (push) Failing after 2m17s
Details

Browse Source
This commit is contained in:
12bitfloat 2025-10-06 13:52:54 +02:00
parent b4ea06cc7a
commit 60cedddde8
2 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Makefile
View File

@ -21,12 +21,14 @@ build_borded_cpp:
build_risspam: build_risspam:
@echo "Compiling 12bitfloat_risspam project." @echo "Compiling 12bitfloat_risspam project."
cd 12bitfloat_rust/risspam && cargo run --release && cp target/release/risspam ../../ cd 12bitfloat_rust/risspam && cargo build --release && cp target/release/risspam ../../
build_jest: build_jest:
@echo "compiling jest_rust project" @echo "compiling jest_rust project"
cd jest_rust && cargo build --release && cp target/release/jisspam .. cd jest_rust && cargo build --release && cp target/release/jisspam ..
build_all: build build_py build_cpp build_borded_cpp build_risspam build_jest
run: run_spam wl run_not_spam run: run_spam wl run_not_spam
run_risspam: run_spam_risspam run_not_spam_risspam run_risspam: run_spam_risspam run_not_spam_risspam
@ -59,9 +61,14 @@ publish:
@./publish risspam @./publish risspam
@rm publish @rm publish
@rm env.py @rm env.py
benchmark: benchmark:
-@rm -rf books -@rm -rf books
@echo "Extracting books." @echo "Extracting books."
@tar -xzf books.tar.gz books/ @tar -xzf books.tar.gz books/
@echo "Extracted books." @echo "Extracted books."
@python bench.py @python bench.py
# Skip extracting books over and over
benchmark_only:
@python bench.py

29
README.md
View File

@ -1,21 +1,36 @@
# Isspam # 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. This repository contains multiple versions of the same(-ish) algorithm.
Versions: ## Versions
- C (isspam) written by **@retoor**
- Rust (risspam) written by **@12bitfloat**
- C++ (isspam_cpp) written by **@BordedDev**
- Rust (jisspam) written by **@jestdotty**
- Rust (risspam) written by 12bitfloat.
- C (isspam) written by retoor.
## Building ## Building
Build all versions to the repo root:
``` ```
make build make build_all
``` ```
Build isspam with memory check (requires valgrind to be installed):
Build isspam (C) with memory check (requires valgrind to be installed):
``` ```
make valgrind make valgrind
``` ```
## Benchmarking
After all binaries have been build to the repo root, you can benchmark them like this:
```
make benchmark
```
or without extracting books again:
```
make benchmark_only
```
## Running ## Running
### Using files as parameter ### Using files as parameter
``` ```