From 1ca9055590b1e6953c3ccc6f92a6ce889caa6c56 Mon Sep 17 00:00:00 2001
From: Nick White <git@njw.me.uk>
Date: Fri, 30 Jul 2010 20:18:52 +0100
Subject: Added man page, tidied docs
---
Makefile | 16 ++++++++++------
README | 22 +++++++++++++++-------
TODO | 6 ++++--
font.h | 7 +------
sintable.h | 7 +------
spout.1 | 34 ++++++++++++++++++++++++++++++++++
spout.c | 7 +------
spout.h | 7 +------
8 files changed, 67 insertions(+), 39 deletions(-)
create mode 100644 spout.1
diff --git a/Makefile b/Makefile
index d479cce..31f402b 100644
--- a/Makefile
+++ b/Makefile
@@ -7,11 +7,14 @@ TARGETS = $(NAME)
OBJ = $(SRC:.c=.o)
MAN = $(TARGETS:=.1)
+HEADERS = spout.h font.h sintable.h
+WEB = web/index.html
+
include config.mk
all: $(TARGETS)
-$(OBJ): config.mk spout.h
+$(OBJ): config.mk $(HEADERS)
.c.o:
@echo CC $<
@@ -21,12 +24,16 @@ $(TARGETS): $(OBJ)
@echo LD $@
@cc -o $@ $(OBJ) $(LDFLAGS)
+$(WEB): web/doap.ttl
+ @echo making webpage
+ @sh web/makepage.sh "Spout - A simple caveflying game" web/doap.ttl > $(WEB)
+
clean:
- rm -f -- $(TARGETS) $(OBJ) $(NAME)-$(VERSION).tar.gz $(NAME)-$(VERSION).tar.gz.sig
+ rm -f -- $(TARGETS) $(WEB) $(OBJ) $(NAME)-$(VERSION).tar.gz $(NAME)-$(VERSION).tar.gz.sig
dist: clean
@mkdir -p $(NAME)-$(VERSION)
- @cp -R $(SRC) $(NAME).h Makefile config.mk COPYING README $(NAME)-$(VERSION)
+ @cp -R $(SRC) $(HEADERS) Makefile config.mk COPYING README $(NAME)-$(VERSION)
@for i in $(MAN); do \
sed "s/VERSION/$(VERSION)/g" < $$i > $(NAME)-$(VERSION)/$$i; done
@tar -c $(NAME)-$(VERSION) | gzip -c > $(NAME)-$(VERSION).tar.gz
@@ -52,7 +59,4 @@ uninstall:
@echo uninstalling manual pages from $(DESTDIR)$(MANPREFIX)/man1
@for i in $(MAN); do rm -f $(DESTDIR)$(MANPREFIX)/man1/$$i; done
-test: all
- @echo no tests yet!
-
.PHONY: all clean dist install uninstall test
diff --git a/README b/README
index f46bc73..5326f27 100644
--- a/README
+++ b/README
@@ -1,7 +1,8 @@
Spout
=====
-Spout is a simple caveflying game. The object is to get as high as possible, avoiding or destroying obstacles.
+Spout is a simple caveflying game. The aim is to get as high as
+possible, avoiding or destroying obstacles.
Requirements
------------
@@ -16,14 +17,21 @@ Edit config.mk to your liking, then run 'make install'
Controls
--------
-Left: Rotate left
-Right: Rotate right
-Space: Accelerate
+Left: Rotate left
+Right: Rotate right
+Space: Accelerate
+Pause: Esc
Exit: Shift-Esc
History
-------
-Spout was originally made for a handheld by kuni, and soon afterwards was ported to Windows using cygwin and sdl, licensed under the MIT license; see http://www.din.or.jp/~ku_/junk/junk.htm#spout
-In 2004 a 'unix version' was released, which mostly just slapped autotools into the windows version and infringed the license: http://code.mizzenblog.com/category/spout/
-This is a new unix version, based on the original Windows code by kuni, which aims to add useful features and simplify the code.
+Spout was originally written for a handheld by kuni, and soon
+afterwards was ported to Windows using cygwin and sdl and released
+under the MIT license.
+
+In 2004 a 'unix version' was released, which mostly just slapped
+autotools into the windows version and infringed the license.
+
+This is a new unix version, based on the original Windows code by
+kuni, which aims to add useful features and simplify the code.
diff --git a/TODO b/TODO
index 69803c5..03a3ab6 100644
--- a/TODO
+++ b/TODO
@@ -2,8 +2,10 @@ remove functions which are more trouble than they're worth
check function return values more
set controls and default zoom and fullscreen in config.h
move useful stuff from spout.h to spout.c
-
-create man page
+rewrite control handling
+change pause to P or PauseBreak
+hide cursor in fullscreen
+up as accelerate option
add gamemode where one has to destroy everything before progressing (or something)
add mod music
diff --git a/font.h b/font.h
index 4eb4908..5c7579d 100644
--- a/font.h
+++ b/font.h
@@ -1,9 +1,4 @@
-/*
- * This file is part of Spout
- *
- * See COPYING file for copyright, license and warranty details.
- *
- */
+/* See COPYING file for copyright, license and warranty details */
const unsigned char FONT6[] = {
// 80, 77, 66, 80, 20, 6, 0, 0, 1, 0, 128, 0, 96, 0, 223, 119,
diff --git a/sintable.h b/sintable.h
index dc83953..23c7b1f 100644
--- a/sintable.h
+++ b/sintable.h
@@ -1,9 +1,4 @@
-/*
- * This file is part of Spout
- *
- * See COPYING file for copyright, license and warranty details.
- *
- */
+/* See COPYING file for copyright, license and warranty details */
short sintable[1024]={
0, 25, 50, 75, 101, 126, 151, 176,
diff --git a/spout.1 b/spout.1
new file mode 100644
index 0000000..5a74cfd
--- /dev/null
+++ b/spout.1
@@ -0,0 +1,34 @@
+.\" See COPYING file for copyright, license and warranty details.
+.TH SPOUT 1 spout\-VERSION
+.SH NAME
+spout \- a simple caveflying game.
+.SH SYNOPSIS
+.B spout
+.RB [-f]
+.RB [-z\ zoom]
+.SH DESCRIPTION
+Spout is a simple caveflying game. The object is to get as high
+as possible, avoiding or destroying obstacles.
+.SH OPTIONS
+.TP
+.B \-f
+Fullscreen
+.TP
+.B \-z zoom
+Zooms the screen by zoom times (default: 4)
+.SH USAGE
+.TP
+.B Left
+Rotate left
+.TP
+.B Right
+Rotate right
+.TP
+.B Space
+Thrust
+.TP
+.B Escape
+Pause
+.TP
+.B Shift\-Escape
+Quit
diff --git a/spout.c b/spout.c
index f3844b9..df82429 100644
--- a/spout.c
+++ b/spout.c
@@ -1,9 +1,4 @@
-/*
- * This file is part of Spout
- *
- * See COPYING file for copyright, license and warranty details.
- *
- */
+/* See COPYING file for copyright, license and warranty details */
#include <stdio.h>
#include <stdlib.h>
diff --git a/spout.h b/spout.h
index 88d6562..34f7457 100644
--- a/spout.h
+++ b/spout.h
@@ -1,9 +1,4 @@
-/*
- * This file is part of Spout
- *
- * See COPYING file for copyright, license and warranty details.
- *
- */
+/* See COPYING file for copyright, license and warranty details */
#define SDL_WIDTH (128 * zoom)
#define SDL_HEIGHT (88 * zoom)
--
cgit v1.2.3