yves-biener/sp
1
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

doc: update installation documentation

Browse Source
This commit was merged in pull request #5.
This commit is contained in:
Yves Biener
2023-10-14 12:06:49 +02:00
parent 7d10ee4c75
commit bea4861232
1 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,17 +2,28 @@
Spellchecking utility to provide automatic corrected spelling for the provided input using GNU/linux ispell. Spellchecking utility to provide automatic corrected spelling for the provided input using GNU/linux ispell.
## Dependencies
Install `ispell` with your favorite package-manager (on manually), as long as `ispell` in available in the PATH environment variable sp will find the executable to run.
## Installation ## Installation
Build the tool using the following command: Build the tool using the following command:
```bash ```sh
zig build -Doptimize=ReleaseFast zig build -Doptimize=ReleaseFast
``` ```
If you wish to install it into */usr/local/* you will have to provide the prefix argument:
```sh
sudo zig build install -p /usr/local/ -DoptimizeReleaseFast
```
This was build using zig 0.12.0.dev but should work with the most recent version of zig. 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. Add the build `sp` executable in your `PATH` environment or install it using the prefix argument to easily invoke the tool.
## Usage ## Usage
@@ -23,3 +34,9 @@ sp pple
# is equivalent to # is equivalent to
echo pple | sp echo pple | sp
``` ```
When running the installation you also install the man page for `sp`. In case you installed in */usr/local/* as the prefix argument you can simply run
```sh
man sp
```