From d9238fc6c4a4ceaeab31be2908ade413e52b60b4 Mon Sep 17 00:00:00 2001 From: Nick Bowler Date: Fri, 3 Jun 2022 00:58:57 -0400 Subject: [PATCH] Add initial README. --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fce990d --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +RRace is a slide puzzle racing game. The goal is to re-arrange coloured tiles +in the game area to create the objective pattern as quickly as possible. + +The game is inspired by Rubik's Race, a board game for two players that dates +back to the Rubik's Cube craze in the early 1980s, which you can apparently +still buy in 2022. + +# Prerequisites + +RRace is written in C, so a working C compiler is compiled. + +To build the UI for X11 systems, the [Motif toolkit][motif-homepage] is +required. + +Optionally, in order to support localized program messages the [GNU libintl +library][gettext-homepage] (included wit the GNU C library) is required. + +[motif-homepage]: https://sourceforge.net/projects/motif/ +[gettext-homepage]: https://www.gnu.org/software/gettext/ + +# Playing the Game + +The game is played on a 5x5 grid of tiles, called the *game area*, containing +24 tiles in 6 different colours--4 of each colour. There is one *empty +position* in the game area. The *goal area* is a 3x3 grid of tiles which +displays the *objective* pattern that must be formed to win the game. + +Selecting a tile in the same row or column as the empty position will "slide" +that tile, along with any tiles between it and the empty position, into the +empty space. The new empty position will be at the selected location. Such +moves are repeated until the colours in the centre 3x3 subgrid of the game +area match the objective. + +Since there are four tiles in each colour, any of those tiles may be used +to match any of the corresponding positions in the objective. Together with +the fact that only a portion of the game area needs to be solved, this makes +the game considerably easier than a more traditional slide puzzle. + +# Contributing + +Please send suggestions, bug reports, patches or any other +correspondence regarding RRace by electronic mail to +[Nick Bowler \][email]. + +[email]: mailto:nbowler@draconx.ca + +# License + +RRace is free software: you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License or (at your option) any later +version. + +{::comment} +Copyright © 2022 Nick Bowler +{:/comment} -- 2.43.2