diff options
| author | Matt Hunter <m@lfurio.us> | 2026-05-31 22:29:38 -0400 |
|---|---|---|
| committer | Matt Hunter <m@lfurio.us> | 2026-05-31 22:29:38 -0400 |
| commit | c91124f69d901416399aad6a721c23077edd3cd5 (patch) | |
| tree | 802b70f4dadafc0a1565aa7a4d793e4ec60809c1 /Makefile | |
| parent | 33b795656240bbcfa9e9548307c2087fb14b92d1 (diff) | |
| parent | 63e0d7677201e4f175742c0a51edbac9c81abf96 (diff) | |
| download | git-sonar-c91124f69d901416399aad6a721c23077edd3cd5.tar.gz git-sonar-c91124f69d901416399aad6a721c23077edd3cd5.zip | |
Merge branch 'docs'
Completely rewrite documentation, in preparation of the new release.
The README.md file was already a little inaccurate and desynced from the
last tagged git-sonar script, but now that the files have been
redesigned, documentation is in need of a complete face lift.
I've opted to move the meat of the user-facing documentation into
manpages, so that the high fidelity documentation is more accessible on
demand. This also better opens the door for packaging of git-sonar down
the road, providing some form of documentation that will get 'installed'
along with the tool.
The output of --help for each script is removed, and instead --help will
recall that script's manpage using the 'man' command. This is done to
make it more obvious that more verbose docs exist, as well as to reduce
the number of spots for documentation that need to be kept in sync.
README is stripped down to function as a higher-level project
information file, which is more focused and easier to navigate now that
usage documentation has its own home.
* docs:
Replace README with new project information
precheck: Add documentation in new manpage
Update core documentation as git-sonar manpage
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -1,4 +1,5 @@ SOURCE=git-sonar git-precheck +MANPAGES=git-sonar.1 git-precheck.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 |