Rich-Harris/svelte-cubed

`svelte-cubed` development: please document dependency on local `pnpm.overrides` in `README.md`

delhanty opened this issue · 1 comments

Instructions for developing svelte-cubed in README.md don't work because of an undocumented dependency on a specific local directory tree containing @sveltejs/kit and "@sveltejs/site-kit. This can be seen by inspecting the pnpm.overrides field in the package.json:

"pnpm": {
		"overrides": {
			"@sveltejs/kit": "link:../../KIT/kit/packages/kit",
			"@sveltejs/site-kit": "link:../../sites/packages/site-kit"
		}
	}

Reproduction

Assuming pnpm is already installed,

pnpm install

results in an error

ENOENT  ENOENT: no such file or directory, realpath '/Users/paul/dev/KIT/kit/packages/kit'

or similar.

Keep going following the README.md instructions,

Run `pnpm dev -- --open` to launch the demo site.

and the demo site fails to open

sh: svelte-kit: command not found
 ELIFECYCLE  Command failed.