Change documentation in README file #26
Merged
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
This commit makes the following changes: - Clean up some of the wording in the introduction - Add a table of content at the beginning of the document - Add an overview of all availale functions - Move the "Options" section up before the full API description - Add some link to Wikipedia pages for further information
chadwhitacre
approved these changes
Apr 7, 2020
|
@martin-schulze-vireso I found this improved readme really helpful. It fixes the especially confusing links to the old outdated repos. Could it be merged in? |
|
Thanks for the ping @jlisee. I did not peek beyond core, yet. |
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.
As I felt the documentation in the readme was not as inviting to people coming to this project without previous knowledge (other than the existence of BATS), I made an attempt to improve it.
This MR makes the following changes: