Improve Documentation #8
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheDavSmasher
approved these changes
Apr 25, 2025
TheDavSmasher
left a comment
TheDavSmasher
left a comment
There was a problem hiding this comment.
I don't know as much as James would but everything added seems reasonably useful, but I can still wait for external confirmation to actually merge. However, I will still approve it so it is ready for whenever that happens
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a couple of missing javadoc comments and adds a README providing necessary background info for contributing and explaining how to build, run, and navigate the code inside the repo.
README preview
@frozenfrank anything you think I missed that would be useful for future TAs? (or the professors if needed?)