search

Nucleo-Estudantes-Informatica-ISEP / antirecurso

Wanna pass your exams? We gotcha! 😉
https://antirecurso.nei-isep.org
GNU General Public License v3.0
12 stars 8 forks source link

Update for Issue #47 #53

Closed MiguelOliveira1200874 closed 1 year ago

MiguelOliveira1200874 commented 1 year ago

Pull Request: Update for Issue #47

Description: This pull request addresses Issue #47 by updating the README.md file to provide a more comprehensive and up-to-date overview of the Antirecurso project. The changes made include:

  1. Updated the introduction section to provide a clearer and more concise description of the project.
  2. Reorganized and expanded the "About the Project" section to provide a better understanding of the evolution of Antirecurso from a mobile app to a comprehensive study platform.
  3. Added a new section, "Usage Examples," to provide step-by-step instructions on how to use Antirecurso and included relevant screenshots for better visualization.
  4. Updated the "Tech Stack" section to reflect the transition to the Next.js framework and provided a brief explanation of Next.js, Tailwind CSS, and Alpine.js.
  5. Updated the "Contributions" section to provide clearer instructions for contributing to the project.
  6. Added a new section, "License Information," to provide information about the project's open-source license and the freedoms it provides.
  7. Made minor formatting and styling improvements throughout the README.md file.

Changes Made:

Please review and let me know if any further changes are required. Thank you!

MiguelOliveira1200874 commented 1 year ago

@ricardo177m Corrected everything you said and added a RoadMapSection according to some of your instructions https://github.com/Nucleo-Estudantes-Informatica-ISEP/antirecurso/pull/53/commits/9766bd0b6d8b98ae3d5f8538d8fad550cd186da0

ricardo177m commented 1 year ago

@MiguelOliveira1200874 Well done! One more thing: we're missing the fork part from the contributions section. Could you please add it and fix the typo in "Contribuitions" (line 109)?

MiguelOliveira1200874 commented 1 year ago

@ricardo177m Added the Contact Us Section and corrected what you asked for.

PS : Please check the email i sent you on support.antirecurso@nei-isep.org.