Start with a skeleton for the project

Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>

1 files changed, 41 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e0bfa31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+This is a port to the NES of the renown
+[jetpac](https://en.wikipedia.org/wiki/Jetpac) game from Ultimate Play the Game.
+You can find a ROM to play the game in the [releases
+page](https://github.com/mssola/jetpac.nes/releases).
+
+## The game
+
+The game follows the original as much as possible. Some things had to be adapted
+because of hardware differences. For example, the colors are a bit different
+because the NES offers a fixed set of them and that's it. Other than small
+differences I'm sure that the feel from the game might be a bit different too.
+Some of it might be attributed to, again, the nature of the NES, but some other
+bit of this can be attributed directly to me. Hence, if you know how to improve
+the game (by being closer to the original), [do tell me](./CONTRIBUTING.md)!
+
+Other than that, the game is a shooter in which you have to re-assemble your
+ship's parts and fill it with fuel, all while killing enemies that keep popping
+up. The controls are as follows:
+
+| Button                                         | Action                |
+|:----------------------------------------------:|:----------------------|
+| <kbd>Start</kbd>                               | Pause/Resume the game |
+| <kbd>Select</kbd>                              | *Not used*            |
+| <kbd>A</kbd>                                   | Throttle              |
+| <kbd>B</kbd>                                   | Shoot                 |
+| <kbd>Arrow Left</kbd> & <kbd>Arrow Right</kbd> | Move horizontally     |
+| <kbd>Arrow up</kbd>                            | Throttle              |
+| <kbd>Arrow down</kbd>                          | *Not used*            |
+
+## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small)
+
+Read the [CHANGELOG.md](./CHANGELOG.md) file.
+
+## License
+
+The original game was developed and published by Ultimate Play the Game and
+released for the ZX Spectrum and VIC-20 in 1983 and the BBC Micro in 1984. Thus,
+the original idea is not mine, and I only did the porting to the NES/Famicom
+platform. This port is released under the
+[GPLv3+](http://www.gnu.org/licenses/gpl-3.0.txt), Copyright (C) 2023-<i>Ω</i>
+Miquel Sabaté Solà.