Updated README.md to include table of contents, why this project is useful, and how to contribute, and added an output for one command #558
Conversation
This file contains 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
…seful, and how to contribute
arhaque09
changed the title
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.
Description of Changes:
-Added table of contents after the nanoGPT section
-Added a section called "Why would I use this?" that explains why nanoGPT is useful
-Added a "First Time Contributors" section to explain how to format code according to the existing code's format, how to raise a pull request, and how to format the pull request for it to be accepted.
-Added output for the python data/shakespeare_char/prepare.py to for users to see what output should look like after running that command in the quick-start section