Update README with more troubleshooting

This commit is contained in:
Tijmen van der Kemp 2025-06-10 11:08:57 +02:00 committed by Tijmen van der Kemp
parent 07cb5fa92b
commit bca95d42f8

View File

@ -17,7 +17,7 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
#### Running Locally #### 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* - *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` 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. - Install git, and then run `git init` in the folder of the project.
- *Lefthook seems to be stuck running the post-merge check* - *Lefthook seems to be stuck running the post-merge check*
- You likely need to press 'Enter'. - 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 #### Linting