john-slop/README.md

43 lines
1.5 KiB
Markdown

# John Slop
![version](badges/version.svg)
![tests](badges/test.svg)
![test coverage](badges/coverage.svg)
John Slop is an early-stage, local-first linter for concrete signs of low-effort
or insufficiently reviewed text and source code. It reports explainable
heuristics for human review; it does not prove AI authorship or identify a
model.
Today, the detector reads UTF-8 files, directories, ZIP archives, and common
ZIP-based office documents. Its first conservative rule family identifies
configured non-ASCII hyphen-like characters and exposes safe ASCII replacement
edits. Broader data-driven heuristics, terminal diagnostics, a formatter, and an
LSP are planned in [tasks.md](tasks.md).
## Quick start
Rust 1.98.1 or newer is required.
```sh
cargo run --bin john-slop -- path/to/document path/to/source-directory
```
Use `--fail-confidence 0..100` to make the detector exit with status `1` when a
document reaches a chosen evidence threshold. Confidence measures configured
signals, not the probability that AI wrote the content.
## Documentation
- [Documentation index](docs/README.md)
- [Command-line usage and current capabilities](docs/usage.md)
- [Architecture and public library API](docs/architecture.md)
- [Development, tests, features, and coverage](docs/development.md)
- [Design decision records](docs/decisions/)
- [Background reading](docs/background.md)
The ordered implementation plan lives in [tasks.md](tasks.md), and contribution
rules live in [AGENTS.md](AGENTS.md).
John Slop is distributed under the [MIT license](LICENSE).