Skip to content

Commit

Permalink
doc/README: Initial Readme Text
Browse files Browse the repository at this point in the history
Fixes #11
  • Loading branch information
laurensvalk committed Apr 24, 2020
1 parent 9e56e7a commit 45ad275
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
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.md>`_ 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/

0 comments on commit 45ad275

Please sign in to comment.