This PR updates the README.md file to include information about the requirements, installation steps, and packages used in the project. It provides users with clear instructions on how to set up and run the project locally, as well as an overview of the project's dependencies.
Summary of Changes
Added a Requirements section to outline the prerequisites for running the project, such as Node.js and npm.
Included a step-by-step Installation guide on how to clone the repository, install the dependencies using npm, and start the development server.
Added a Packages section to provide a brief description of the key packages used in the project, such as Next.js, Tailwind CSS, and Radix UI, and explain their roles in the project.
Please review and merge this PR to update the README.md file and improve the documentation for the project.
Fixes #6.
To checkout this PR branch, run the following command in your terminal:
git checkout sweep/update-readme
To get Sweep to edit this pull request, leave a comment below or in the code. Leaving a comment in the code will only modify the file but commenting below can change the entire PR.
Description
This PR updates the
README.md
file to include information about the requirements, installation steps, and packages used in the project. It provides users with clear instructions on how to set up and run the project locally, as well as an overview of the project's dependencies.Summary of Changes
Please review and merge this PR to update the
README.md
file and improve the documentation for the project.Fixes #6.
To checkout this PR branch, run the following command in your terminal:
To get Sweep to edit this pull request, leave a comment below or in the code. Leaving a comment in the code will only modify the file but commenting below can change the entire PR.