Clean up the README #1363
Closed
Clean up the README #1363
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
|
The readme was including this material on purpose, if you want to write different/better teaching material on candle that's very welcome and useful but please do so in some external repo/blog/... |
|
Ok, sure. Just wanted to see if this could help. Thanks! |
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.
I reduced the README source line count by 61% (currently is 39% of original line count!). This reduction was accomplished without deletion of material from the repository. When applicable, I moved the following sections from the README to the Book:
Additionally, I condensed the features section to show only the "big ideas" and avoid listing all the models. The original section has also been moved to the Book.
Please see my fork of Candle for comparison.
I have 2 questions: