From d0f1559f485d5eead4cd7137b5e55ed315b4e1fe Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sat, 15 May 2021 15:01:08 -0400 Subject: [PATCH] Add manpage --- .gitignore | 1 + Makefile | 10 +++++++--- README | 2 +- pong.1.scd | 18 ++++++++++++++++++ 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 pong.1.scd diff --git a/.gitignore b/.gitignore index 8e55469..f326245 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ pong +pong.1 diff --git a/Makefile b/Makefile index 269671b..a234c45 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,14 @@ all: - ${CC} -o pong pong.c ${CLAGS} -lcurses ${LDFLAGS} + ${CC} -o pong pong.c ${CLAGS} -Wall -Wextra -std=c99 -pedantic \ + -lcurses ${LDFLAGS} + scdoc < pong.1.scd > pong.1 -install: +install: all + mkdir -p /usr/local/bin /usr/local/share/man/man1 cp pong /usr/local/bin/pong + cp pong.1 /usr/local/share/man/man1/pong.1 uninstall: - rm /usr/local/bin/pong + rm /usr/local/bin/pong /usr/local/share/man/man1/pong.1 .PHONY: all diff --git a/README b/README index 86b5774..305de6c 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ pong ---- -Simple pong game in ncurses. +Simple pong game in ncurses. Further documentation can be found pong(1). Copyright Armaan Bhojwani MIT License 2021. diff --git a/pong.1.scd b/pong.1.scd new file mode 100644 index 0000000..360c026 --- /dev/null +++ b/pong.1.scd @@ -0,0 +1,18 @@ +pong(1) + +# NAME +pong - play a game of pong + +# SYNOPSIS +pong + +# DESCRIPTION +Simple text-mode pong game in ncurses + +# AUTHOR +Armaan Bhojwani + +https://sr.ht/~armaan/pong + +# LICENSE +Copyright Armaan Bhojwani MIT License 2021. -- 2.39.2