Updating Documentation for Clarity and Structure

  • Summary of Changes This MR updates the README file to improve clarity and structure, making it easier for new users to understand the installation process and usage of the project. There is also an issue tracker page for a guideline in reporting issues.

  • Purpose These changes aim to condense the information to navigate and understand the project more efficiently and add some missing information like contributions and issue tracking.

  • Specifics

  • Revised the README for easier navigation and clarity
  • Added a contribution section for guideline to contribute
  • Added an issue tracker page for specifics on reporting issues found in the project
  • Impact These improvements will enhance user experience, reduce confusion, and encourage more contributors to engage with the project.

Merge request reports

Loading