diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2025-06-29 21:03:01 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2025-06-29 21:03:01 -0400 |
| commit | 571cfa50d2955f1bb49c406554d1de041d58614f (patch) | |
| tree | 26bbe1fdbe466c2147d630a056faab8ad1710e1c /README.md | |
| parent | Fix justify behavior (diff) | |
| download | cli-571cfa50d2955f1bb49c406554d1de041d58614f.zip | |
Add documentation for how to install justify cli
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -22,3 +22,29 @@ documents. `justify` achieves this by adding extra space between words or letters to ensure that each line extends to the right margin. The last line of a paragraph is not justified and is aligned left. + +## Installation + +1. Clone the repository +```sh +$ git clone https://github.com/eugenetriguba/justify +$ cd justify +``` + +2. Create a build directory and build the project +``` +$ cmake -B build -DCMAKE_BUILD_TYPE=Release +$ cmake --build build +``` + +3. Install the binary and man page (may require sudo) +```sh +$ sudo cmake --install build +``` + +This will: +- Install the `justify` binary to your system’s default binary directory (e.g., `/usr/local/bin`) +- Install the man page to the appropriate man directory (e.g., `/usr/local/share/man/man1`) + +You can then use the `justify` CLI and view the man page via `man justify`. + |