Update README.md

sorairolake · May 5, 2024 · 21d79c3 · 21d79c3
1 parent 48b3d0d
commit 21d79c3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -57,14 +57,21 @@ others.
 
 #### How to build
 
+To build the command-line utility:
+
 ```sh
-# command-line utility
 just build-cmd
+```
+
+To build a man page:
 
-# man page
+```sh
 just build-man
 ```
 
+The man page is generated in `docs/man/man1`. Note that [Asciidoctor] is
+required when building the man page.
+
 ### Usage
 
 Please see [`glzip(1)`].
@@ -109,6 +116,7 @@ licensing information.
 [`example_test.go`]: example_test.go
 [Homebrew]: https://brew.sh/
 [release page]: https://github.com/sorairolake/lzip-go/releases
+[Asciidoctor]: https://asciidoctor.org/
 [`glzip(1)`]: docs/man/man1/glzip.1.adoc
 [CHANGELOG.adoc]: CHANGELOG.adoc
 [CONTRIBUTING.adoc]: CONTRIBUTING.adoc

diff --git a/justfile b/justfile
@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
 alias all := default
+alias build-cmd := build-cmd-debug
 
 # Run default recipe
 default: test