diff --git a/README.md b/README.md index d16e9db..01e27fb 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,29 @@ Smuggler's Run is a minimalist space adventure game, where you, the player, are This game is not meant to be played on a small mobile screen. -## Getting Started +## Installation & Running -First, run the development server: +This project is bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). + +### Prerequisites + +**Node.js**: Version 20 LTS or higher is recommended. + +### Setup + +Install Dependencies: + +```bash +npm install +# or +yarn install +# or +pnpm install +``` + +### Getting Started + +Start the development server: ```bash npm run dev @@ -14,14 +34,10 @@ npm run dev yarn dev # or pnpm dev -# or -bun dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. - ## Features - simple d6 based mechanics