diff --git a/README.md b/README.md index 253f795..1aba3b6 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ -# Gravwell-Online \ No newline at end of file +# Gravwell-Online + +## Development: +Below are the steps required to run the code in development mode: + + 1. Clone the git repository + 2. Go into the common code module: `cd common` + 3. Tell the Typescript compiler to watch for all updates in the module using: + `tsc --watch` + 4. In a new terminal: `cd web-svelte` + 5. Install the required dependencies: `pnpm install` + 6. Run Vite: `pnpm dev` \ No newline at end of file