README.md: provide screenshots and explanation about prebuilt images
This commit is contained in:
parent
ad298095b3
commit
0fed5cc550
Binary file not shown.
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
21
README.md
21
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
|
`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
|
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
|
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
|
possible to stream game data from a computer over the serial port on the
|
||||||
console, allowing quicker development under real hardware.
|
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
|
`Airport` has moved from a `Makefile`-based build system towards `cmake` for
|
||||||
convenience, easier deployment and generation of `compile_commands.json`,
|
convenience, easier deployment and generation of `compile_commands.json`,
|
||||||
useful for improved text completion on some IDEs. `cmake >= 3.13` is required.
|
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
|
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.
|
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
|
`Airport` is licensed under the GPLv3 or later (read `LICENSE`) unless noted
|
||||||
otherwise. Some assets with various permissive licenses are also used - see
|
otherwise. Some assets with various permissive licenses are also used - see
|
||||||
`LICENSE` files on each subfolder for further reference.
|
`LICENSE` files on each subfolder for further reference.
|
||||||
|
|
Loading…
Reference in New Issue