Commit c43b5b5b authored by Tim Stadtmann's avatar Tim Stadtmann
Browse files

Update readme.md

parent 839e8d0a
......@@ -5,7 +5,7 @@ Mindstorms EV3 Toolbox for MATLAB!
This toolbox was designed to simplify controlling LEGO MINDSTORMS EV3
robots live using MATLAB. Via Bluetooth or USB you can easily read sensor values
or control your robots’ motors. You can choose to either work on a high level,
working a virtual twin of your EV3, or follow the EV3's firmware specification
with a virtual twin of your EV3, or follow the EV3's firmware specification
by sending commands directly.
This toolbox is being developed at the RWTH Aachen, Germany, and it is the
......@@ -24,7 +24,7 @@ This toolbox has been developed and tested on MATLAB 2014a/2016a, on Windows
configurations, feel free to contact us.
The EV3's firmware version needs to be updated to 1.09, bugs and unsuspected
behaviour have been encountered when we use older versions.
behaviour have been encountered when we used older versions.
## Installation
In most cases, you will only need to download the toolbox and add its path to
......@@ -60,8 +60,9 @@ b.beep();
b.disconnect();
```
You can find more information on the toolbox functions/classes either by using
*help functionname/classname* and *doc functionname/classname* in your MATLAB
editor, or in the PDF/HTML documentation inside the subfolder *docs*.
*help classname.functionname* and *doc classname.functionname* in your MATLAB
editor (the *.functionname* is optional), or in the PDF/HTML documentation
inside the subfolder *docs*.
## Contribution
......@@ -80,6 +81,9 @@ pip install -U sphinxcontrib-matlabdomain
pip install sphinx_bootstrap_theme
```
Note: If you get 'permission-denied' errors on the pip install lines, try adding
'--user *your_username*' to each pip install line.
You also need to setup your latex parser if you want Sphinx to generate pdfs:
```
sudo apt install texlive-latex-base
......@@ -96,3 +100,4 @@ make latexpdf
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment