top: Update top-level docs. #576
Conversation
0b1aaaf to
ac7acf7
Compare
|
See the rendered copy here: https://github.com/micropython/micropython-lib/blob/top-level-docs/README.md |
README.md
Outdated
| in other Python environments. This includes drivers for hardware | ||
| (e.g. sensors, peripherals, or displays), or libraries to work with | ||
| embedded functionality (e.g. bluetooth), or MicroPython-specific | ||
| packages that do not have equivalents in CPython. |
There was a problem hiding this comment.
| in other Python environments. This includes drivers for hardware | |
| (e.g. sensors, peripherals, or displays), or libraries to work with | |
| embedded functionality (e.g. bluetooth), or MicroPython-specific | |
| packages that do not have equivalents in CPython. | |
| in other Python environments. This includes drivers for hardware | |
| (e.g. sensors, peripherals or displays), libraries to work with | |
| embedded functionality (e.g. bluetooth) or MicroPython-specific | |
| packages that do not have equivalents in CPython. |
README.md
Outdated
|
|
||
| Other libraries are packages, in which case you'll need to copy the directory instead. For example, to add `collections.defaultdict`, copy `collections/collections/__init__.py` and `collections.defaultdict/collections/defaultdict.py` to a directory named `lib/collections` on your device. | ||
| ### On a network-enabled device: |
There was a problem hiding this comment.
I was under the impression that, generally, colons in titles were considering unnecessary. Style choice though!
CONTRIBUTING.md
Outdated
| required functionality can be installed. The way to do this is to have a | ||
| base package, e.g. `mypackage` containing `mypackage/__init__.py`, and then | ||
| an "extension" package, e.g. `mypackage-ext` containing additional files | ||
| e.g. `mypackage/ext.py`. See `collections-defaultdict` as an example. |
There was a problem hiding this comment.
Should add a link if we want the user to see an example:
| e.g. `mypackage/ext.py`. See `collections-defaultdict` as an example. | |
| e.g. `mypackage/ext.py`. See [`collections-defaultdict`](https://github.com/micropython/micropython-lib/tree/master/python-stdlib/collections-defaultdict) as an example. |
There was a problem hiding this comment.
I don't think code can also be a link?
There was a problem hiding this comment.
It did render correctly when I tried it in the Discussion preview window...
There was a problem hiding this comment.
You're right! That's neat. Updated.
ac7acf7 to
443e303
Compare
|
Thanks @mattytrentini -- updated! |
|
Looks great to me, fantastic work. I now feel the examples to manually copy code onto devices is almost too much, but serves to highlight how easy mip is by comparison. |
443e303 to
b9710e0
Compare
|
I also had a previous PR to add since developer guidance to the readme, there might be a couple of extra notes there worth adding (though you've certainly covered most of it now) https://github.com/micropython/micropython-lib/pull/495/files |
* Add instructions for how to use micropython-lib. * Add a terminology guide and use consistent terminology (package/module/library). * Improve code conventions and contributor guidelines. * Misc readme updates. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
399df07 to
a9e52d0
Compare
|
Thanks, updated! |
This work was funded through GitHub Sponsors.