Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify README.md #14

Closed
dylanson25 opened this issue Oct 1, 2024 · 0 comments · Fixed by #20
Closed

Modify README.md #14

dylanson25 opened this issue Oct 1, 2024 · 0 comments · Fixed by #20
Assignees

Comments

@dylanson25
Copy link
Owner

Description:

This issue involves updating the README.md file to provide clear and concise information about the project, setup instructions, and any necessary details for developers or users interacting with the repository.

Tasks:

  1. Project Overview:

    • Add a brief description of the project, explaining its purpose and main features.
    • Mention that the project is built using Astro.js and any other relevant technologies (e.g., Tailwind CSS, ESLint, Prettier, etc.).
  2. Installation Instructions:

    • Provide detailed steps for setting up the project locally.
    • Include instructions to clone the repository, install dependencies, and run the project.
      npm install
      npm run dev
  3. Build & Deployment:

    • Explain how to build the project for production.
      npm run build
    • Add instructions for deployment, especially if using a specific platform like Netlify or Vercel.
  4. Scripts Overview:

    • Add a section that explains the available npm scripts (e.g., npm run dev, npm run lint, npm run build, etc.).
  5. Technologies Used:

    • Provide a list of the main technologies and libraries used in the project, such as Astro.js, Tailwind CSS, ESLint, Prettier, etc.
  6. License (Optional):

    • Specify the license under which the project is distributed (if applicable).
  7. Contact Information:

    • Provide contact information or links for any further inquiries or support related to the project.

Criteria for Closure:

  • The README.md includes a clear project overview, installation instructions, and other necessary sections.
  • The document is formatted correctly and is easy to follow.
@dylanson25 dylanson25 added this to the Phase 1: Base Configuration milestone Oct 1, 2024
dylanson25 added a commit that referenced this issue Oct 3, 2024
@dylanson25 dylanson25 linked a pull request Oct 3, 2024 that will close this issue
dylanson25 added a commit that referenced this issue Oct 3, 2024
@dylanson25 dylanson25 self-assigned this Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant