Documentation edits to README.md

Proposed edits to increase user readability and ease of use of the README page.
pull/5/head
Carol Willing 2014-08-04 18:15:00 -07:00
rodzic ad7b1ad64e
commit 4b70d46de3
1 zmienionych plików z 30 dodań i 25 usunięć

Wyświetl plik

@ -1,37 +1,40 @@
~~~~
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
micropython-lib is highly experimental community project.
micropython-lib is a "highly experimental" community project.
Please help to drive it to just "expiremental" state by testing
Please help to drive it to just "experimental" state by testing
provided packages with MicroPython.
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
~~~~
micropython-lib
===============
micropython-lib is a project to develop non-monolothic standard library
for MicroPython. Each module or package is available as a seprate
distribution package from PyPI. Modules either written from scratch or
ported from CPython. Note that main target of micropython-lib is so
far "Unix" port of MicroPython. Actual requirements vary per module
(basicly, if module is not related to I/O, it should work without
problem on baremetal ports too).
micropython-lib is a project to develop a non-monolothic standard library
for MicroPython. Each module or package is available as a separate
distribution package from PyPI. Each module is either written from scratch or
ported from CPython.
Note that the main target of micropython-lib is a "Unix" port of MicroPython
(future ports to be determined). Actual system requirements vary per module.
Though if a module is not related to I/O, the module should work without
problem on bare-metal ports too.
Usage
-----
micropython-lib packages are published on PyPI (Python Package Index),
standard Python community package repository: http://pypi.python.org/ .
You can search for MicroPython related packages, read additional info,
etc.
the standard Python community package repository: http://pypi.python.org/ .
On PyPi, you can search for MicroPython related packages and read
additional package information.
To install packages from PyPI for usage on your local system, use
"pip-micropython" tool, which is a simple wrapper around a standard
"pip" tool, which is used to install package for CPython.
"pip-micropython" tool can be found in "tools" subdirectory of the main
MicroPython repository (https://github.com/micropython/micropython).
Just install "pip-micropython" script somewhere on your PATH.
To install packages from PyPI for usage on your local system, use the
`pip-micropython` tool, which is a simple wrapper around the standard
`pip` tool, which is used to install packages for CPython.
The `pip-micropython` tool can be found in `tools` subdirectory
of the main MicroPython repository (https://github.com/micropython/micropython).
Just install the `pip-micropython` script somewhere on your `PATH`.
Afterwards, just use pip-micropython in a way similar to pip:
Afterwards, just use `pip-micropython` in a way similar to `pip`:
~~~~
$ pip-micropython install micropython-copy
@ -41,21 +44,23 @@ $ micropython
[1, 2, 3]
~~~~
Review pip-micropython source code for more info.
Review the `pip-micropython` source code for more info.
Development
-----------
To install modules during development, use "make install". By default, it
will install all available packages. You can pass MOD=<module> parameter
to install specific module.
To install modules during development, use `make install`. By default, all
available packages will be installed. To install a specific module, add the
`MOD=<module>` parameter to the end of the `make install` command.
Links
-----
More info:
More information is on GitHub and in the MicroPython forums:
* https://github.com/micropython/micropython/issues/405
* http://forum.micropython.org/viewtopic.php?f=5&t=70
Basic guidelines for installing packages from PyPI:
For basic guidelines for installing packages from PyPI:
* https://github.com/micropython/micropython/issues/413