From e8590e68eb9e41fded451407ed06fe1a7f8aff37 Mon Sep 17 00:00:00 2001 From: John Zaitseff Date: Sat, 2 Jul 2011 10:17:03 +1000 Subject: [PATCH] Add README files to the src and doc subdirectories --- doc/Makefile.am | 1 + doc/README | 9 +++++++++ src/Makefile.am | 2 ++ src/README | 17 +++++++++++++++++ 4 files changed, 29 insertions(+) create mode 100644 doc/README create mode 100644 src/README diff --git a/doc/Makefile.am b/doc/Makefile.am index 437f39a..64e23e9 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -27,3 +27,4 @@ # along with this program. If not, see http://www.gnu.org/licenses/. dist_man6_MANS = trader.6 +EXTRA_DIST = README diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..7ad0974 --- /dev/null +++ b/doc/README @@ -0,0 +1,9 @@ +************************************************************************** +* * +* Star Traders: A Game of Interstellar Trading * +* Copyright (C) 1990-2011, John Zaitseff * +* * +************************************************************************** + +This directory, "doc", contains documentation related to Star Traders. In +particular, the Unix manual page for the game is in the file "trader.6". diff --git a/src/Makefile.am b/src/Makefile.am index 190cf92..6cd625a 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -36,3 +36,5 @@ trader_SOURCES = \ system.h trader_LDADD = @CURSES_LIB@ + +EXTRA_DIST = README diff --git a/src/README b/src/README new file mode 100644 index 0000000..f9521f3 --- /dev/null +++ b/src/README @@ -0,0 +1,17 @@ +************************************************************************** +* * +* Star Traders: A Game of Interstellar Trading * +* Copyright (C) 1990-2011, John Zaitseff * +* * +************************************************************************** + +This directory, "src", contains the main source code to Star Traders. The +source code is split up among the following files: + + trader.h - Main program header file + trader.c - Main program, command-line interface + system.h - All system header files are included here + globals.h - Global game constants and variables + globals.c - Global game variables + utils.h - Utility functions header file + utils.c - Utility functions needed by Star Traders