macerobotics / MRPiZ

MRPiZ robot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MRPiZ robot

MRPiZ is small Open Source mobile robot.

Overview

The repository is organised as follows:

  • Hardware: schematics of the board
  • Software: Python, C, java API and examples
  • doc: Documentation

Generating the documentation

The documentation is made using the Sphinx tool and the read the doc theme:

sudo apt install python3-sphinx
sudo pip3 install sphinx_rtd_theme

To generate the documentation go to the doc/fr directory, then run:

make html

The output is generated in the build/html dir, open the build/html/index.html file with firefox.

Licence

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

About

MRPiZ robot


Languages

Language:C 80.2%Language:Python 14.8%Language:Java 4.9%Language:Shell 0.1%