diff --git a/README.md b/README.md index 198f009..8fb5883 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# caa-game \ No newline at end of file +# caa-game +Welcome to the official repository of caa-game. Here one can track the progress of this wonderful game, and find the installation instructions. + +### 🏗️ Installation +To install, clone this repo, and run npm install. +```bash +git clone https://gitea.arnweb.nl/Hecc-inc./caa-game.git && cd caa-game +npm install +``` + +If you want to run this game, enter `npm start` in your terminal. + +### 🛠️ Building +To build this game into a distributable format, + - run `npm run build:win` on windows. + - run `npm run build:mac` on macOS. + - run `npm run build:linux` on linux. \ No newline at end of file