26 lines
698 B
Markdown
26 lines
698 B
Markdown
# sp
|
|
|
|
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. The `<word>` may also be provided instead using pipes.
|
|
|
|
```bash
|
|
sp pple
|
|
# is equivalent to
|
|
echo pple | sp
|
|
```
|