Docs: Update setup instructions to use pnpm #80
+25
−18
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.md
to recommendpnpm
for dependency installation and for running the development server.Reasoning:
The project contains a
pnpm-lock.yaml
file, which indicates thatpnpm
is the intended package manager. The previous instructions recommendednpm
, which could lead to several issues for new contributors:npm
andpnpm
can resolve dependencies differently, potentially leading to anode_modules
state that is inconsistent with the lock file. This can cause subtle bugs or break the application, like thelightningcss
error that was encountered.npm install
, apackage-lock.json
file might be created, leading to confusion about which lock file is the source of truth.By aligning the documentation with the project's setup, we can provide a smoother onboarding experience for new developers and prevent common setup-related issues.
This change also includes a note on how to install
pnpm
for users who might not have it installed.