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 da43caf
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
Pybricks API
=============
Pybricks end-user API & Documentation
=====================================

This repository documents the Pybricks end-user MicroPython API.

Each [Pybricks firmware](https://github.com/pybricks/pybricks-micropython)
comes with the [pybricks](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](https://docs.pybricks.com/).

See the [contributor's guide](CONTRIBUTING.md) for acceptable changes and
instructions to build the documentation locally.

Description

0 comments on commit da43caf

Please sign in to comment.