From d19097bf16b02bc3e9eca104c28a0bcc470e9af8 Mon Sep 17 00:00:00 2001 From: One-Nose <64845824+One-Nose@users.noreply.github.com> Date: Tue, 4 Jul 2023 03:27:53 +0300 Subject: [PATCH] chore(readme): create readme file --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..21bb83a --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Minecraft-2D +This is a two-dimensional clone of the video game Minecraft. + +## Building +To build, you will have to have NodeJS and npm installed. +Fork this repository and run `npm install` in its root directory. +Run `npm run serve` to serve the game on `localhost`. +Run `npm run build` to build the project into the `dist` folder.