update README with working setup #94
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
|
Thank you @fredcallaway ! I’ll incorporate the changes in documentation once I get back from vacation. As for ToC - indeed, maintaining it manually is tedious but as it provides value for the users - I usually generate it automatically using a shell script like https://github.com/Lirt/markdown-toc-bash |
|
Ah that's a useful script, thanks for the tip! |
|
Thanks a lot for contributing the improvements and I apologies for the delay - the work is a bit overwhelming ATM. |
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.
Note that I rearranged things a bit as well (moving the authentication instructions into the Setup section, which replaces Install).
I also removed depth-2 TOC items b/c I think the benefit is outweighed by the cost of maintaining them.