Skip to content

Docs/readme update #1

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.

Sign up for GitHub

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

Jump to bottom
Open
walbeck85 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs/readme update #1

walbeck85 wants to merge 3 commits into from

Conversation

@walbeck85
Copy link

@walbeck85 walbeck85 commented Oct 7, 2025

Best practice for documentation steps. Add comments to code to explain purpose and logic

  • Clarify intent / functionality of code to other developers.
  • Add screenshot of completed work included in Markdown in README.
  • Update README textLinks to an external site. to reflect the functionality of the application.
  • Delete any stale branches on GitHub.
  • Remove unnecessary/commented out code.
  • If needed, update git ignore to remove sensitive data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@walbeck85