commit 4ca5d318e2c2146355dd28e4ee8a6940304808da parent 2467fa19411d70c64dd3bafc465784568964ec5a Author: Christos Margiolis <christos@margiolis.net> Date: Wed, 21 Oct 2020 14:46:21 +0300 added manpage Diffstat:
| M | Makefile | | | 13 | ++++++------- |
| A | chip8.1 | | | 15 | +++++++++++++++ |
2 files changed, 21 insertions(+), 7 deletions(-)
diff --git a/Makefile b/Makefile @@ -6,7 +6,7 @@ include config.mk BIN = chip8 DIST = ${BIN}-${VERSION} -#MAN1 = ${BIN}.1 +MAN1 = ${BIN}.1 SRC = chip8.c OBJ = chip8.o @@ -36,17 +36,16 @@ run: ./${BIN} install: all - #${MKDIR} ${DESTDIR}${BIN_DIR} ${DESTDIR}${MAN_DIR} - ${MKDIR} ${DESTDIR}${BIN_DIR} + ${MKDIR} ${DESTDIR}${BIN_DIR} ${DESTDIR}${MAN_DIR} ${CP} ${BIN} ${BIN_DIR} - #${CP} ${MAN1} ${DESTDIR}${MAN_DIR} - #sed "s/VERSION/${VERSION}/g" < ${MAN1} > ${DESTDIR}${MAN_DIR}/${MAN1} + ${CP} ${MAN1} ${DESTDIR}${MAN_DIR} + sed "s/VERSION/${VERSION}/g" < ${MAN1} > ${DESTDIR}${MAN_DIR}/${MAN1} chmod 755 ${DESTDIR}${BIN_DIR}/${BIN} - #chmod 644 ${DESTDIR}${MAN_DIR}/${MAN1} + chmod 644 ${DESTDIR}${MAN_DIR}/${MAN1} uninstall: ${RM} ${DESTDIR}${BIN_DIR}/${BIN} - #${RM} ${DESTDIR}${MAN_DIR}/${MAN1} + ${RM} ${DESTDIR}${MAN_DIR}/${MAN1} clean: ${RM} ${BIN} ${OBJ} ${DIST}.tar.gz diff --git a/chip8.1 b/chip8.1 @@ -0,0 +1,15 @@ +.Dd chip8\-VERSION +.Dt CHIP\-8 1 +.Os +.Sh NAME +.Nm chip8 +.Nd a minimal CHIP\-8 emulator +.Sh SYNOPSIS +.Nm +.Op CHIP8_FILE +.Sh DESCRIPTION +.Nm +reads a CHIP\-8 ROM and executes it. It uses the SDL2 +library as a rendering API. +.Sh AUTHORS +.An Christos Margiolis Aq Mt christos@christosmarg.xyz