-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
17 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,18 @@ | ||
Pybricks API | ||
============= | ||
Pybricks end-user API & Documentation | ||
===================================== | ||
|
||
Description | ||
This repository documents the Pybricks end-user MicroPython API. | ||
|
||
Each `Pybricks firmware`_ comes with the `Pybricks package`_. All modules, classes, methods, | ||
and functions in that package have optimized implementations in C for high | ||
performance and reduced memory footprint. | ||
|
||
This repository provides an empty, pure Python blueprint of that package. It is | ||
used to generate the `official documentation`_. | ||
See the `contributor's guide <contributing>`_ for acceptable changes and | ||
instructions to build the documentation locally. | ||
|
||
.. _Pybricks package: pybricks | ||
.. _Pybricks firmware: https://github.com/pybricks/pybricks-micropython | ||
.. _official documentation: https://docs.pybricks.com/ | ||
.. _contributing: CONTRIBUTING.md |