From bca95d42f8dbc095477ed7c6070b9d1d607173ac Mon Sep 17 00:00:00 2001 From: Tijmen van der Kemp Date: Tue, 10 Jun 2025 11:08:57 +0200 Subject: [PATCH] Update README with more troubleshooting --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40312cc5cb8..b6632110b49 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ If you have the motivation and experience with Typescript/Javascript (or are wil #### Running Locally -1. Clone the repo and in the root directory run `npm install` +1. **Clone** the repo and in the root directory run `npm install` - *if you run into any errors, check out Troubleshooting below and then reach out in the **#dev-corner** channel in discord* 2. Run `npm run start:dev` to locally run the project in `localhost:8000` @@ -26,6 +26,10 @@ Troubleshooting: - Install git, and then run `git init` in the folder of the project. - *Lefthook seems to be stuck running the post-merge check* - You likely need to press 'Enter'. +- *I ran `npm run start:dev` but it didn't seem to start anything* + - If the last message before your command was `lefthook something something post-merge`, your `run` command got eaten by the Lefthook monster, but running it again will work. +- *I started the game but all text looks like code instead of actual sentences* + - You likely downloaded the code instead of cloning the repository, meaning that the localization submodule did not get included. Can you start again and clone the repository instead of downloading the code as a ZIP file? #### Linting