generated from OPCODE-Open-Spring-Fest/template
-
Notifications
You must be signed in to change notification settings - Fork 9
Closed
Labels
FRESHERS ONLYType:EasydocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfest-accepted
Description
So, what is it about?
The existing README.md file exhibits minor spelling errors, inconsistent formatting, and a lack of clear structure, which negatively impacts readability. This issue proposes to enhance and standardize the documentation to facilitate comprehension of the project's setup and objectives for new contributors and users. Specifically, it is suggested that instructions for compilation, execution, and setup, currently found in project_tour.md, be incorporated into the README.md file.
Code of Conduct
- I agree to follow this project's Code of Conduct
Metadata
Metadata
Assignees
Labels
FRESHERS ONLYType:EasydocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfest-accepted