From e7fee29e5b30f6c7e3b8854ece32830d68fb9515 Mon Sep 17 00:00:00 2001 From: John Zaitseff Date: Mon, 25 Jul 2011 17:00:59 +1000 Subject: [PATCH] Final minor edits of various documentation files --- NEWS | 18 ++++++++++++------ README | 4 ++-- build-aux/README | 8 ++++---- doc/README | 2 +- doc/trader.6 | 17 +++++++++-------- lib/README | 5 +++-- m4/README | 2 +- src/README | 2 +- 8 files changed, 33 insertions(+), 25 deletions(-) diff --git a/NEWS b/NEWS index 1b27634..f5f8eab 100644 --- a/NEWS +++ b/NEWS @@ -20,11 +20,16 @@ Version 7.0 (not yet released) Released the first version of Star Traders for Unix-like operating systems such as Linux. It requires a text console or window of at least 80x24 in -size. The code is written in the C programming language as a learning +size. The code is written in the C99 programming language as a learning exercise for a number of software tools and libraries; the algorithms in the original Pascal and Visual Basic versions are reused for the game logic. +Note that the current version of Star Traders does NOT handle locales with +multibyte character sequences (such as UTF-8) correctly. Each byte in a +multibyte sequence is treated as a separate character. Eight-bit locales +(such as US-ASCII, ISO8859-1, etc.) work correctly. + Early history ------------- @@ -40,16 +45,17 @@ using Turbo Pascal 3.01a. Essentially, only the name of the game and some of the ideas were retained in this version. Version 4.1 of Star Traders was released on 1st August, 1991. -In 1992, it was recompiled for the NEC Advanced Personal Computer (with 8" -drives!) running CP/M-86 on an 8086 processor, using Turbo Pascal 2.0. -This version had colour added to it in the form of ANSI escape sequences; -version 4.4 was released on 2nd August, 1993. +In 1992, it was recompiled for the NEC Advanced Personal Computer (with +8-inch floppy drives!) running CP/M-86 on an 8086 processor, using Turbo +Pascal 2.0. This version had colour added to it in the form of ANSI +escape sequences; version 4.4 was released on 2nd August, 1993. The next version came in 1993, when the program was recompiled to run on IBM-compatible machines running MS-DOS and ANSI.SYS. Turbo Pascal 6.0 was used for this. The ANSI escape sequences were slightly different under MS-DOS than under the NEC, in that the NEC supported a number of extra -character attributes. +character attributes. In other words, the MS-DOS version looked worse +than the one running under CP/M-86! Star Traders was recompiled again in 1994 for IBM-compatible machines with VGA/EGA/CGA video graphics adapters. The output routines were recoded to diff --git a/README b/README index db13c62..af40616 100644 --- a/README +++ b/README @@ -31,8 +31,8 @@ Star Traders comes with quite extensive in-built instructions on how to play the game. Start by running "trader" from the command line. You will be prompted for the number of players; from one to eight people can play (although, in this version, they will all have to share the one keyboard -and screen!). After entering in the names of the players, you will have -the opportunity to read instructions on how to play the game. Do so---and +and screen!). After entering the names of the players, you will have the +opportunity to read instructions on how to play the game. Do so---and good luck in the game! The manual page for Star Traders contains more information on command line diff --git a/build-aux/README b/build-aux/README index 8a0383e..70cf99f 100644 --- a/build-aux/README +++ b/build-aux/README @@ -5,7 +5,7 @@ * * ************************************************************************** -This directory, "build-aux", contains auxiliary build-related files for -Star Traders. Apart from "bootstrap", all files are generated by either -Autoconf, Automake or Gnulib. The script "bootstrap" generates these -files by running those tools in the correct order. +This directory, build-aux, contains auxiliary build-related files for Star +Traders. Apart from "bootstrap" (and this README file, of course), all +files are generated by either Autoconf, Automake or Gnulib. The bootstrap +script generates these files by running those tools in the correct order. diff --git a/doc/README b/doc/README index 7ad0974..b6ea180 100644 --- a/doc/README +++ b/doc/README @@ -5,5 +5,5 @@ * * ************************************************************************** -This directory, "doc", contains documentation related to Star Traders. In +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/doc/trader.6 b/doc/trader.6 index 4e8fd74..e8d96a5 100644 --- a/doc/trader.6 +++ b/doc/trader.6 @@ -105,8 +105,8 @@ options: Once the game starts, you will be asked to enter the number of people playing. From one to eight people can play (although, in this version, they will all have to share the one keyboard and screen!). After -entering in the names of the players, you will have the opportunity to -read instructions on how to play the game. Do so\(emand good luck in the +entering the names of the players, you will have the opportunity to read +instructions on how to play the game. Do so\(emand good luck in the game! .PP If you would like to continue a previously-saved game, simply specify @@ -120,7 +120,7 @@ game 4, if it was previously saved: If you are running under the X Window System, you might like to start the game in a dedicated .BR xterm (1) -window (all on one line): +window (typed all on one line): .RS .sp .nh @@ -131,7 +131,7 @@ window (all on one line): .sp .RE If you would like a full \*(lqretro-computing\*(rq green-screen -experience, try (again, all on one line): +experience, try (again, typed all on one line): .RS .sp .nh @@ -236,15 +236,16 @@ the game and some of the ideas were retained in this version. Version 4.1 of Star Traders was released on 1st August, 1991. .PP In 1992, it was recompiled for the NEC Advanced Personal Computer (with -8-inch drives!) running CP/M-86 on an 8086 processor, using Turbo Pascal -2.0. This version had colour added to it in the form of ANSI escape -sequences; version 4.4 was released on 2nd August, 1993. +8-inch floppy drives!) running CP/M-86 on an 8086 processor, using Turbo +Pascal 2.0. This version had colour added to it in the form of ANSI +escape sequences; version 4.4 was released on 2nd August, 1993. .PP The next version came in 1993, when the program was recompiled to run on IBM-compatible machines running MS-DOS and ANSI.SYS. Turbo Pascal 6.0 was used for this. The ANSI escape sequences were slightly different under MS-DOS than under the NEC, in that the NEC supported a number of -extra character attributes. +extra character attributes. In other words, the MS-DOS version looked +worse than the one running under CP/M-86! .PP Star Traders was recompiled again in 1994 for IBM-compatible machines with VGA/EGA/CGA video graphics adapters. The output routines were diff --git a/lib/README b/lib/README index 9c7b48e..f158155 100644 --- a/lib/README +++ b/lib/README @@ -5,5 +5,6 @@ * * ************************************************************************** -This directory, "lib", contains source code as generated by the Gnulib GNU -Portability Library (http://www.gnu.org/software/gnulib/) "gnulib-tool". +This directory, lib, contains source code as generated by the Gnulib GNU +Portability Library "gnulib-tool" script. See the project web site at +http://www.gnu.org/software/gnulib/ for more information. diff --git a/m4/README b/m4/README index de2bbec..aedfad5 100644 --- a/m4/README +++ b/m4/README @@ -5,7 +5,7 @@ * * ************************************************************************** -This directory, "m4", contains M4 macros used by Autoconf. +This directory, m4, contains M4 macros used by Autoconf. The following macros are from the Autoconf Archive project, as detailed on that project's web site, http://www.gnu.org/software/autoconf-archive/: diff --git a/src/README b/src/README index a88e884..a52e7cc 100644 --- a/src/README +++ b/src/README @@ -5,7 +5,7 @@ * * ************************************************************************** -This directory, "src", contains the main source code to Star Traders. The +This directory, src, contains the main source code for Star Traders. The source code is split up among the following files: trader.c trader.h - Main program, command-line interface