README.md

@@ -2,17 +2,28 @@
 
 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
 
 Build the tool using the following command:
 
-```bash
+```sh
 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.
 
-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
 
@@ -23,3 +34,9 @@ sp pple
 # is equivalent to
 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
+```

build.zig

@@ -23,6 +23,8 @@ pub fn build(b: *std.Build) void {
         .target = target,
         .optimize = optimize,
     });
+    // install man pages along executable
+    b.installFile("doc/sp.1", "man/man1/sp.1");
 
     // This declares intent for the executable to be installed into the
     // standard location when the user invokes the "install" step (the default

doc/sp.1

@@ -0,0 +1,38 @@
+.\" This is the groff documentation source for sp
+.\"
+.\" Preview with: groff -man -Tascii sp.1
+.\"           or: man -l sp.1
+.\"
+
+.TH SP 1 "2023-10-14" "User Commands"
+.SH NAME
+sp \- A ispell wrapper to automatically correct spelling errors
+.SH SYNOPSIS
+.B sp
+.RI WORD
+.
+.SH DESCRIPTION
+.B sp
+Is a cli tool to automatically select the first correction of the provided word using gnu/linux ispell.
+.PP
+sp is a wrapper program around ispell
+.
+.SH EXAMPLES
+sp opprotunity
+.PP
+echo opprotunity | sp
+.PP
+Both sp executions will result into the same output of
+.I opportunity
+wether you provide the word as an command line argument or pipe the argument to sp.
+.
+.SH AUTHOR
+Written by Yves Biener.
+Man page by Yves Biener.
+.
+.SH BUGS
+Please report bugs at
+.IR https://gitea.yves-biener.de/yves-biener/sp/issues
+.
+.SH COPYRIGHT
+This software is provided by Yves Biener ''as is'' and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Yves Biener be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.