Files
pybricks-api/doc/api/index.rst
T
Laurens Valk bcf610a29e doc/index: regroup hubs by platform
Make it easier to pick the right installation guide.
2020-10-25 19:51:40 +01:00

94 lines
1.9 KiB
ReStructuredText

Welcome to Pybricks!
==================================================================
This documentation has everything you need to install Pybricks and
run your first scripts.
**Step 1: Install Pybricks**
Pybricks scripts are the same across all hubs. The only difference is in how
you install Pybricks and how you run scripts. To get started, click one of
the platforms below.
.. list-table::
* - **MINDSTORMS EV3**
- **Powered Up (Technic/City/BOOST)**
- **SPIKE / MINDSTORMS Inventor**
* - .. image:: images/ev3brick.png
:target: start_ev3.html
- .. figure:: images/powereduphubs.png
:target: start_pup.html
- .. figure:: images/primeinventorhub.png
:target: start_inventor.html
**Step 2: Start coding!**
After you've followed the installation steps for your hub,
check out the Pybricks modules in the left hand menu to see what
you can do.
**Step 3: Share what you made (or ask for help!)**
Got questions or issues? Please share your
findings on our `support page`_ so we can make Pybricks even better.
*Thank you!*
.. _support page: https://github.com/pybricks/support/issues/
.. toctree::
:maxdepth: 1
:caption: Table of Contents
:hidden:
.. toctree::
:maxdepth: 1
:caption: Pybricks
:hidden:
Home Page <https://pybricks.com>
Downloads <https://pybricks.com/downloads/>
Example Projects <https://github.com/pybricks/pybricks-projects>
Support <https://github.com/pybricks/support/issues/>
About Pybricks <https://pybricks.com/about/>
.. toctree::
:maxdepth: 1
:caption: Getting started
:hidden:
start_ev3
start_pup
start_inventor
.. toctree::
:maxdepth: 1
:caption: Pybricks Modules
:hidden:
hubs
pupdevices
ev3devices
nxtdevices
iodevices
parameters
tools
robotics
media
messaging
.. toctree::
:maxdepth: 1
:caption: Engineering Extras
:hidden:
signaltypes
motors
.. frames