Skip to content

Commit e375a91

Browse files
committed
Merge pull request micropython#5 from willingc/patch-1
Documentation edits to README.md
2 parents ad7b1ad + 4b70d46 commit e375a91

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,40 @@
11
~~~~
22
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3-
micropython-lib is highly experimental community project.
3+
micropython-lib is a "highly experimental" community project.
44
5-
Please help to drive it to just "expiremental" state by testing
5+
Please help to drive it to just "experimental" state by testing
66
provided packages with MicroPython.
77
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
88
~~~~
99

1010
micropython-lib
1111
===============
12-
micropython-lib is a project to develop non-monolothic standard library
13-
for MicroPython. Each module or package is available as a seprate
14-
distribution package from PyPI. Modules either written from scratch or
15-
ported from CPython. Note that main target of micropython-lib is so
16-
far "Unix" port of MicroPython. Actual requirements vary per module
17-
(basicly, if module is not related to I/O, it should work without
18-
problem on baremetal ports too).
12+
micropython-lib is a project to develop a non-monolothic standard library
13+
for MicroPython. Each module or package is available as a separate
14+
distribution package from PyPI. Each module is either written from scratch or
15+
ported from CPython.
16+
17+
Note that the main target of micropython-lib is a "Unix" port of MicroPython
18+
(future ports to be determined). Actual system requirements vary per module.
19+
Though if a module is not related to I/O, the module should work without
20+
problem on bare-metal ports too.
21+
1922

2023
Usage
2124
-----
2225
micropython-lib packages are published on PyPI (Python Package Index),
23-
standard Python community package repository: http://pypi.python.org/ .
24-
You can search for MicroPython related packages, read additional info,
25-
etc.
26+
the standard Python community package repository: http://pypi.python.org/ .
27+
On PyPi, you can search for MicroPython related packages and read
28+
additional package information.
2629

27-
To install packages from PyPI for usage on your local system, use
28-
"pip-micropython" tool, which is a simple wrapper around a standard
29-
"pip" tool, which is used to install package for CPython.
30-
"pip-micropython" tool can be found in "tools" subdirectory of the main
31-
MicroPython repository (https://github.com/micropython/micropython).
32-
Just install "pip-micropython" script somewhere on your PATH.
30+
To install packages from PyPI for usage on your local system, use the
31+
`pip-micropython` tool, which is a simple wrapper around the standard
32+
`pip` tool, which is used to install packages for CPython.
33+
The `pip-micropython` tool can be found in `tools` subdirectory
34+
of the main MicroPython repository (https://github.com/micropython/micropython).
35+
Just install the `pip-micropython` script somewhere on your `PATH`.
3336

34-
Afterwards, just use pip-micropython in a way similar to pip:
37+
Afterwards, just use `pip-micropython` in a way similar to `pip`:
3538

3639
~~~~
3740
$ pip-micropython install micropython-copy
@@ -41,21 +44,23 @@ $ micropython
4144
[1, 2, 3]
4245
~~~~
4346

44-
Review pip-micropython source code for more info.
47+
Review the `pip-micropython` source code for more info.
48+
4549

4650
Development
4751
-----------
48-
To install modules during development, use "make install". By default, it
49-
will install all available packages. You can pass MOD=<module> parameter
50-
to install specific module.
52+
To install modules during development, use `make install`. By default, all
53+
available packages will be installed. To install a specific module, add the
54+
`MOD=<module>` parameter to the end of the `make install` command.
55+
5156

5257
Links
5358
-----
54-
More info:
59+
More information is on GitHub and in the MicroPython forums:
5560

5661
* https://github.com/micropython/micropython/issues/405
5762
* http://forum.micropython.org/viewtopic.php?f=5&t=70
5863

59-
Basic guidelines for installing packages from PyPI:
64+
For basic guidelines for installing packages from PyPI:
6065

6166
* https://github.com/micropython/micropython/issues/413

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy