Update install doc #37
Open
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
1. Change to atx headings instead of Setext
2. Remove <a> anchors -- not needed
3. Updated install instructions
a. Changed the order of doing things to be more logical
b. Added more detail about downloading micropython
c. Updated virtual env setup to use current Python `venv` tool
d. Added info about PowerShell example scripts
e. Add image from Windows device Manager
garthk
reviewed
Jan 27, 2021
* Added suggestions by @garthk -- thanks * Updated for mpfshell 0.9.2 1. Added requirements file with correct version of mpfshell 2. More help on venv for novices 3. Added more details and links
garthk
approved these changes
Jan 28, 2021
ReadMe.md
Outdated
Comment on lines
68
to
71
| ``` | ||
| . .venv/bin/activate # Linux and macOS | ||
| . .venv\Scripts\activate.ps1 # Windows | ||
| ``` |
There was a problem hiding this comment.
It's a little fiddly, but there'll be at least one indent level at which you can put the fenced code block inside the list item instead of stopping the list and starting a new one afterward.
| - On Windows, use the command `change port /query` to discover the COM port. | ||
|
|
||
| - Export the serial port to an environment variable, so helpder sripts can use it, | ||
| e.g `export AMPY_PORT=<port>` or `$env:AMPY_PORT = COM<n>` where `port` is the device address shown |
There was a problem hiding this comment.
Perhaps note they can get straight to the badge REPL then with mpfshell -o ${AMPY_PORT:4}, at least with a POSIXish shell?
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.
Made a lot of changes to the install doc.
Re ordering, adding details, more info about Windows