-
Notifications
You must be signed in to change notification settings - Fork 999
Open
Description
The Problem
Currently, the README.md
file makes a few assumptions that can be challenging for new contributors:
- It primarily recommends using
bun
, but does not provide installation instructions or alternatives likenpm
oryarn
. This can be a blocker ifbun
is not installed. - When setting up the project with
npm
oryarn
, the development server fails to start due to aRollupError
from thenuxt-simple-sitemap
module.
These issues increase the barrier for new contributors to get the project running locally.
Proposed Solution
I have made the following improvements to the README.md
:
- Added clear instructions for using
npm
andyarn
as alternatives tobun
. - Included a new "Troubleshooting" section that explains how to resolve the
RollupError
by temporarily disabling thenuxt-simple-sitemap
module innuxt.config.ts
.
This will provide a smoother setup experience for future contributors. I will be submitting a Pull Request shortly to address this.
Metadata
Metadata
Assignees
Labels
No labels