Skip to content

Commit 5cb62bf

Browse files
committed
docs: created README.md
1 parent 6d724e8 commit 5cb62bf

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Sphase Invaders
2+
3+
## Description
4+
5+
This is my first attempt at making my very own pixel art-style game using [Phaser](https://docs.phaser.io/phaser/getting-started/what-is-phaser).
6+
I will be implementing the game logic first and then make my own pixel art characters and objects to spice things up.
7+
Entirely developed by my self, in my own free time :sunglasses:
8+
9+
## How to build
10+
11+
I developed the project using Phaser in TypeScript using Vite to build the project.
12+
As such, running `npm run build` will create a `/dist` folder containing all required code and assets.
13+
14+
## How to run
15+
16+
Using simple tools like `serve` you can run the project.

0 commit comments

Comments
 (0)