aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavier Del Campo Romero <xavi.dcr@tutanota.com>2021-08-14 01:11:47 +0200
committerXavier Del Campo Romero <xavi.dcr@tutanota.com>2021-08-14 01:11:47 +0200
commit0fed5cc550f868e7a471cdca2e3da4570489ee9b (patch)
treec740de014e0c58103586fc573278fdaae8c8cddb
parentad298095b358d207a57607446e163044cfe461eb (diff)
README.md: provide screenshots and explanation about prebuilt imagesHEADmaster
-rw-r--r--Documentation/screenshot-2.pngbin0 -> 17073 bytes
-rw-r--r--Documentation/screenshot.pngbin0 -> 22280 bytes
-rw-r--r--README.md21
3 files changed, 18 insertions, 3 deletions
diff --git a/Documentation/screenshot-2.png b/Documentation/screenshot-2.png
new file mode 100644
index 0000000..19727f8
--- /dev/null
+++ b/Documentation/screenshot-2.png
Binary files differ
diff --git a/Documentation/screenshot.png b/Documentation/screenshot.png
new file mode 100644
index 0000000..45d70a3
--- /dev/null
+++ b/Documentation/screenshot.png
Binary files differ
diff --git a/README.md b/README.md
index 1b16abb..7638d22 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,11 @@
-# Overview
+# Airport
+A free (as in free speech) video game for the original PlayStation written
+with [PSXSDK](https://github.com/XaviDCR92/psxsdk).
+
+![Screenshot of in-game footage](Documentation/screenshot.png)
+
+![Another screenshot of in-game footage](Documentation/screenshot-2.png)
+## Overview
`Airport` is a free (as in freedom) video game for the original Sony
Playstation aka PSX. The player puts himself/herself in the role of an Air
Traffic Controller (ATC) where inbound and outbound flights must be brought to
@@ -21,7 +28,15 @@ compatible with [OpenSend](https://github.com/XaviDCR92/OpenSend), making it
possible to stream game data from a computer over the serial port on the
console, allowing quicker development under real hardware.
-# How to build
+## Running Airport from a prebuilt image
+
+Prebuilt images for common use can be found for each
+[release](https://github.com/XaviDCR92/Airport/releases). These images are
+tipically distributed as a `.bin`/`.cue` file pair that can be used by most
+PSX emulators out there, and can be also burnt into a CD-r and run under
+real hardware.
+
+## How to build
`Airport` has moved from a `Makefile`-based build system towards `cmake` for
convenience, easier deployment and generation of `compile_commands.json`,
useful for improved text completion on some IDEs. `cmake >= 3.13` is required.
@@ -43,7 +58,7 @@ it into a CD-R to play it into a modchipped console.
On the other hand, the map editor must be built using the Qt framework. Qt
Creator automates the process and thus is the recommended way to go.
-# License
+## License
`Airport` is licensed under the GPLv3 or later (read `LICENSE`) unless noted
otherwise. Some assets with various permissive licenses are also used - see
`LICENSE` files on each subfolder for further reference.