Add Tutorial section to README #6
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
billfreeman44
requested changes
Jun 9, 2022
README.rst
Outdated
| Requirements | ||
| ^^^^^^^^^^^^ | ||
|
|
||
| - Linux, macOS, or Windows. |
There was a problem hiding this comment.
Suggested change
| - Linux, macOS, or Windows. |
They better not try this on a TI-84 calculator. "This was tested on windows, mac, and linux." is probably sufficient.
README.rst
Outdated
|
|
||
| - Linux, macOS, or Windows. | ||
| - Git_, `GitHub Desktop`_, or similar Git interface. | ||
| - `Python v3.9`_ and `Poetry v1`_. |
There was a problem hiding this comment.
Suggested change
| - `Python v3.9`_ and `Poetry v1`_. | |
| - `Python v3.9`_. | |
| - `Poetry v1`_. |
|
|
||
| :: | ||
|
|
||
| $ poetry run jupyter notebook notebooks |
There was a problem hiding this comment.
Suggested change
| $ poetry run jupyter notebook notebooks | |
| $ poetry run jupyter notebook notebooks | |
| Or if on Linux: | |
| $ make notebook | |
There was a problem hiding this comment.
Not a bad suggestion, but I only want to give them one option and keep it simple.
billfreeman44
approved these changes
Jun 9, 2022
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.
No description provided.