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

Upgraded the README Documentation: Detailed Project Overview, Table of Contents, Improved Installation Instructions, and Contribution Guide #84

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NitishG23
Copy link

@NitishG23 NitishG23 commented Sep 21, 2024

  • Added a little more detail to the overview, which provides a more proper overview of the calculator.
  • Created a table of contents.
  • Added significantly more detailed installation instructions and even made them formatted in bash for easy copy/paste (and a cleaner look)
  • Provided better formatting (bash) and a little more detail for the 'Usage' section.
  • Created a contribution section that gives clear steps on how to contribute.
    -Fixed spacing error in the Enhancements section, and renamed to 'Enhancements' instead of 'Enhancement'

- Added solid detail to the overview
- Created a table of contents 
- Made more detailed installation instructions and even made them formatted in bash for easy copy/paste. 
- Provided better formatting (bash) and a little more detail for the 'Usage' section 
- Created a contribution section that gives steps on how to contribute. 
-Fixed spacing error in the Enhancements section
@NitishG23 NitishG23 closed this Sep 21, 2024
@NitishG23 NitishG23 reopened this Sep 21, 2024
@NitishG23 NitishG23 changed the title Updated the README.md Upgraded the README Documentation: Detailed Project Overview, Table of Contents, Improved Installation Instructions, and Contribution Guide Sep 21, 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 this pull request may close these issues.

1 participant