add: spellcheck utility implementation using ispell

This commit is contained in:
2023-10-08 12:17:08 +02:00
parent e6a3330a61
commit e8c8fe34db
5 changed files with 211 additions and 1 deletions

View File

@@ -1,3 +1,19 @@
# sp
Spellchecking utility to provide automatic corrected spelling for the provided input using gnu/linux spell.
Spellchecking utility to provide automatic corrected spelling for the provided input using GNU/linux ispell.
## Installation
Build the tool using the following command:
```bash
zig build -Doptimize=ReleaseFast
```
This was build using zig 0.12.0.dev but should work with the most recent version of zig.
Add the build `sp` executable in your `PATH` environment to easily invoke the tool.
## Usage
`sp <word>` to check the provided _word_. Returns the correct spelling of the word. In case of a misspelling the first suggestion of ispell is automatically choosen and returned.