summaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorMatt Hunter <m@lfurio.us>2026-05-24 20:33:33 -0400
committerMatt Hunter <m@lfurio.us>2026-05-31 22:28:36 -0400
commit09a1d8991ce770a55aad05f2c4131a917ded1cb6 (patch)
tree6a2ff4c0e9464fddc95bf821caab873696235772 /Makefile
parent33b795656240bbcfa9e9548307c2087fb14b92d1 (diff)
downloadgit-sonar-09a1d8991ce770a55aad05f2c4131a917ded1cb6.tar.gz
git-sonar-09a1d8991ce770a55aad05f2c4131a917ded1cb6.zip
Update core documentation as git-sonar manpage
The bulk of README.md is reworked, updated for accuracy, and reformatted into git-sonar(1). The output of 'git-sonar --help' is removed as well (melded into the new manpage). Now, specifying --help causes the manpage itself to open. Since 'git-sonar --help' used to be the only way to ask which version of the script is installed, a --version output is added as a terse replacement. The makefile is updated to facilitate installation of this new documentation. Signed-off-by: Matt Hunter <m@lfurio.us>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile12
1 files changed, 7 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index 6edd7f4..de4ba58 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,5 @@
SOURCE=git-sonar git-precheck
+MANPAGES=git-sonar.1
PREFIX?=/usr/local
PWD=$(shell pwd)
@@ -16,13 +17,14 @@ all:
@echo 'If you want to install *git-sonar* for your user only:'
@echo ' PREFIX=$$HOME/.local make install'
-install: $(SOURCE)
- @echo 'Installing in' $(PREFIX)/bin '...'
- mkdir -p $(PREFIX)/bin
+install:
+ @echo 'Installing in' $(PREFIX) '...'
+ mkdir -p $(PREFIX)/bin $(PREFIX)/share/man/man1
install -m 755 $(SOURCE) $(PREFIX)/bin
+ install -m 644 $(MANPAGES) $(PREFIX)/share/man/man1
-# Link each file separately since the full PWD is needed
-develop: $(SOURCE)
+develop:
+ # Link each file separately since the full PWD is needed
@echo 'Symlinking in' $(PREFIX)/bin '...'
mkdir -p $(PREFIX)/bin
ln -sf $(PWD)/git-sonar $(PREFIX)/bin