Skip to content

Update install doc#37

Open
alecthegeek wants to merge 8 commits intogeekscape:masterfrom
alecthegeek:update-install-doc
Open

Update install doc#37
alecthegeek wants to merge 8 commits intogeekscape:masterfrom
alecthegeek:update-install-doc

Conversation

@alecthegeek
Copy link

Made a lot of changes to the install doc.

Re ordering, adding details, more info about Windows

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
Copy link

@garthk garthk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for me to approve, but I'm glad to see these changes, and I've got a couple suggestions.

* 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
Copy link

@garthk garthk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking sharper! Trying the “Approve” option this time, too.

Comment on lines +68 to +71
```
. .venv/bin/activate # Linux and macOS
. .venv\Scripts\activate.ps1 # Windows
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants