micropython / micropython/micropython
docs: Windows port README should include `make submodule` as a build step
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 22.1k
- Forks
- 9k
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 16
Description
Checks
-
I agree to follow the MicroPython Code of Conduct to ensure a safe and respectful space for everyone.
-
I've searched for existing issues and didn't find any that matched.
Documentation URL
https://github.com/micropython/micropython/blob/master/ports/windows/README.md
Description
The build steps for the Windows port are missing make submodule. Build errors occur because micropython-lib (specifically the ssl module) isn't found if that command isn't executed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open ports/windows/README.md and review the existing Windows build steps. Add make submodule where it belongs in the sequence, then check that the documented steps account for micropython-lib, including the ssl module, being available during the build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100