Merge pull request #27 from moggers87/17-update-readme

Update README, NEWS, and AUTHORS

AUTHORS

@@ -1,4 +1,4 @@
-Project Leader: Mark Snellgrove (Original concept and game
-                coding)
+Current maintainer: moggers87 (SDL2 port)
+Original author: Mark Snellgrove (Original concept and game coding)
 Co-author: Mark Harman (First Windows port and SDL conversion)
-Additional contributor: Judebert (Configuration file)
+Additional contributor: Judebert (Configuration file)

NEWS

@@ -1,14 +1,25 @@
-* 03/08/2019 moggers87
+* 2021-02-12 moggers87 0.2.7
+
+- Ported to SDL2
+- Cleaned up code meet modern C++ standards
+- Changelog is now generate from `git log`
+- Game now scales properly on larger screens
+- Configuration is now searched for in multiple places:
+  - ~/.config/apricots/
+  - System config directory (defaults to /usr/local/etc)
+  - Finally, defaults are stored with game data
+
+* 2019-08-03 moggers87
 
 - Applied Fedora patches
 - Added to git repo
 - Regenerated autoconf files without KDE macros
 
-* 13/08/2003 Mark Snellgrove 0.2.6
+* 2003-08-13 Mark Snellgrove 0.2.6
 
 - Version 0.2.6 released
 
-* 08/08/2003 Mark Snellgrove
+* 2003-08-08 Mark Snellgrove
 
 - Sanity check on configuration options now applied
 - Configuration from apricots.cfg extended to all options at runtime
@@ -18,13 +29,13 @@
 - BORLAND specific options in apricots.cpp found to be redundant - Removed.
 - Game speed now properly regulated by TICK_INTERVAL parameter (Fixes BUG2)
 
-* 01/08/2003 Judebert
+* 2003-08-01 Judebert
 
 - Limited Configuration read at runtime from apricots.cfg
 - Windows port of OpenAL audio routines in sampleio class
 - Cygwin compiler flag now checked on main
 
-* 30/07/2003 Mark Snellgrove 0.2.5
+* 2003-07-30 Mark Snellgrove 0.2.5
 
 - Version 0.2.5 released
 - File configure.in now checks for OpenAL (thanks to Jens Thiele)
@@ -43,28 +54,28 @@
 - Options in init_gamedata() function are now fully commented
 - Global parameter GAME_SPEED reduced to 0.2
 
-* 26/07/2003 Mark Snellgrove 0.2.4
+* 2003-07-26 Mark Snellgrove 0.2.4
 
 - Version 0.2.4 released
 - Audio via OpenAL reactivated (via conditional compiler option)
 
-* 24/07/2003 Mark Snellgrove 0.2.3
+* 2003-07-24 Mark Snellgrove 0.2.3
 
 - Version 0.2.3 released
 - SDLfont palettes and masks pre-rendered for speedup
 
-* 17/07/2003 Mark Snellgrove
+* 2003-07-17 Mark Snellgrove
 
 - SDLfont class for rendering fonts in SDL implemented (slow)
 
-* 13/07/2003 Mark Snellgrove 0.2.2
+* 2003-07-13 Mark Snellgrove 0.2.2
 
 - Version 0.2.2 released
 - Existence of apricots.shapes file checked
 - Airbase constructor included (required by Borland compiler)
 - Several minor bugs fixed in shape class
 
-* 09/07/2003 Mark Snellgrove 0.2.1
+* 2003-07-09 Mark Snellgrove 0.2.1
 
 - Version 0.2.1 released
 - Airbase constructors modified
@@ -75,23 +86,23 @@
 - Compilation warnings from implicit casts fixed
 - Compilation warnings in null building definition fixed
 
-* 06/07/2003 Mark Snellgrove 0.2.0
+* 2003-07-06 Mark Snellgrove 0.2.0
 
 - Version 0.2.0 released (SDL version)
 - Fixed up some Linux/Windows portability issues
 - rand() now used as random number generator
 - Font routines temporarily disabled (portability problem)
 
-* 21/06/2003 Mark Harman
+* 2003-06-21 Mark Harman
 
 - Windows port using the SDL graphics library
 - OpenAL Audio temporarily disabled (portability problem)
 - Controls for player 2 disabled.
 
-* 13/09/2002 Mark Snellgrove 0.1.0
+* 2002-09-13 Mark Snellgrove 0.1.0
 
 - Version 0.1.0 released (SVGALIB/OpenAL version)
 
-* 26/03/2002 Mark Snellgrove
+* 2002-03-26 Mark Snellgrove
 
 - SVGALIB/OpenAL version of apricots in playable form.

README.md

@@ -10,6 +10,44 @@ Apricots has nothing to do with apricots. It's a game where you fly a little
 plane around the screen and shoot things and drop bombs on enemy targets, and
 it's meant to be quick and fun.
 
+Installing
+----------
+
+Apricots has been tested on Linux and Mac OS. It should also be buildable on
+any UNIX platform that meets the requirements below.
+
+Windows support is currently unknown. There was Windows support at one point,
+but I don't have access to a Windows machine to check recent changes haven't
+broken anything. Contributions are always welcome!
+
+### Requirements
+
+
+- A C++ compiler (GCC/G++ and Clang/LLVM)
+- SDL > 2.0.0, download from www.libsdl.org
+- OpenAL, download from www.openal-soft.org
+- freealut 1.1.0, download from https://github.com/vancegroup/freealut/releases/tag/freealut_1_1_0
+
+### Buidling from source
+
+```
+./configure # use --prefix= if you want to install to somewhere other than /usr/local
+make
+make install # may require sudo if you don't have permission to write to the target prefix
+```
+
+### Building from git
+
+As well as the requirements for building from source, you will require GNU
+Autotools. The `bootstrap` script will create the `configure` script for you.
+
+```
+./bootstrap
+./configure # use --prefix= if you want to install to somewhere other than /usr/local
+make
+make install # may require sudo if you don't have permission to write to the target prefix
+```
+
 History
 -------
 
@@ -30,56 +68,27 @@ The orginal author, Mark Snellgrove, wrote the following:
 > sound, and intelligent computer AI. Slightly later, in 1996, the Draks were
 > added as a bit of amusement. The result was a highly playable game, which I
 > distributed to a few of my friends. A few years later and I now use a PC,
-> which can run Linux.  Having learnt C++ by this time, at the beginning of
-> 2002 I felt ready enough to port 'Apricots' cross platform from BLITZ on the
-> Amiga to C++ on a Linux PC.  What you see here is work in progress on that
-> port. The game has been tweaked slightly while being ported over, so is not
-> identical to the Amiga version.
+> which can run Linux  Having learnt C++ by this time, at the beginning of 2002
+> I felt ready enough to port 'Apricots' cross platform from BLITZ on the Amiga
+> to C++ on a Linux PC. What you see here is work in progress on that port. The
+> game has been tweaked slightly while being ported over, so is not identical
+> to the Amiga version.
 
 moggers87 took over this project in 2019 as the original website had
 disappeared.
 
 Authors
 -------
 
-- Current maintainer: moggers87
-- Original author: Mark Snellgrove (Original concept and game coding)
-- Co-author: Mark Harman (First Windows port and SDL conversion)
-- Additional contributor: Judebert (Configuration file)
+See AUTHORS
 
 Status
 ------
 
-The game is still under development. Apricots-0.2.6 is a beta release using the
-SDL library. Despite this, it is highly playable. Please open a Github issue to
+The game is still under development. Apricots-0.2.7 is a beta release using the
+SDL2 library. Despite this, it is highly playable. Please open a Github issue to
 report bugs, feature requests, or comments.
 
-C++ Compilers
--------------
-
-Apricots is known to successfully build under the following OS/Compiler
-configurations
-
-- Linux - gcc (reported by Mark Snellgrove)
-- OpenBSD - gcc (reported by Johan Luff)
-- Windows - Borland (reported by Mark Harman)
-- Windows - Visual C++ 6.0 (reported by Mark Snellgrove)
-- Windows/Cygwin - gcc (reported by Judebert)
-
-It may build successfuly on other platforms, but this has not been tested. Let
-me know!
-
-Requirements
-------------
-
-- SDL > 1.2.0, download from www.libsdl.org
-- OpenAL, download from www.openal.org
-
-Compilation options
-
-        -DAP_PATH="datadir" Set directory where apricots looks for
-                            its data files. Defaults to current directory
-                            if unset.
 
 Instructions
 ------------
@@ -92,18 +101,20 @@ ACCELERATE / STEALTH     |     CURSOR UP         |   S
 DROP BOMB                |     CURSOR DOWN       |   X
 FIRE SHOT                |     RETURN            |   LEFT CTRL
 
-Gameplay is fairly common sense to work out.  Stay alive, and shooting enemy
-targets gains you points, whereas being shot down or shooting the wrong things
-lose you points. You have infinite planes, and are competing against the other
-computer planes (or other player!).  First to a certain score wins once they
-land at base.  Simple!
+Stay alive, and shooting enemy targets gains you points, whereas being shot
+down or shooting the wrong things lose you points. You have infinite planes,
+and are competing against the other computer planes (or other player!). First
+to a certain score wins once they land at base.
 
 Play Options
 ------------
 
 At present there is no option screen. Options can be changed by editing the
-configuration file apricots.cfg (on UNIX systems this will probably require
-root access, user configuration files will be added soon in a future release).
+configuration file apricots.cfg. This is first searched for in
+~/.config/apricots/, then the system configuration directory (usually
+/usr/local/etc or /etc) and finally the default configuration in the data
+directory.
+
 The number and type of planes can be varied, along with the airbases, as can
 1/2 player game be chosen. The number of anti aircraft guns and scenery can be
 selected. Draks can be turned on or off, and a different condition for winning
@@ -113,12 +124,12 @@ License
 -------
 
 Apricots falls under the GPL. Please read the file COPYING included in this
-distrubution. The sourcecode of apricots-0.2.6 will either be included in the
-distrubution, or can otherwise be downloaded from the apricots webpage (see
+distrubution. The sourcecode of Apricots will either be included in the
+distrubution, or can otherwise be downloaded from the Apricots webpage (see
 below)
 
 Webpage
 -------
 
-For updates, bugfixes, binaries, sourcecode and more info please visit the
-apricots webpage at https://github.com/moggers87/apricots
+For updates, bugfixes, sourcecode and more info please visit the Apricots
+webpage at https://github.com/moggers87/apricots