Added README.md

This commit is contained in:
Stefan Stefanov 2024-02-12 21:28:34 +02:00
parent bb4393557a
commit fd0cb31206
3 changed files with 26 additions and 0 deletions

26
README.md Normal file
View file

@ -0,0 +1,26 @@
# Space Invaders
## About
This is a simple clone I wrote in a weekend using `odin-lang` and the available `raylib` bindings.
# Software used
* `Aseprite` for pixel art
* `neovim` and the `ols` LSP
* `make`
# Building & running
This should be buildable through the makefile on any platform (Windows, OSX & Linux) as long as you have the Odin compiler on hand.
If the makefile is causing you trouble the project can be directly ran with (which creates a binary file as well):
```bash
odin run .
```
or compiled to a binary with a custom output directory & speed optimizations (although they are not needed at all):
```bash
odin build . -out:space_invaders.exe -o:speed
```
# Gallery
![Space Invaders Start Game Screen](/repo/start_game_screenshot.png)
![In Game Screen](/repo/in_game_screenshot.png)

BIN
repo/in_game_screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB