From ed36b3335eb6b5dcfdfa3b2f5dcce276328417b5 Mon Sep 17 00:00:00 2001
From: Linus Atorf <atorf@mmi.rwth-aachen.de>
Date: Tue, 20 Feb 2018 16:31:27 +0100
Subject: [PATCH] Update readme.md with license, dependency and quoting info
---
readme.md => README.md | 45 +++++++++++++++++++++++++++++++++++-------
1 file changed, 38 insertions(+), 7 deletions(-)
rename readme.md => README.md (69%)
diff --git a/readme.md b/README.md
similarity index 69%
rename from readme.md
rename to README.md
index d9a10ec..b5d42fb 100644
--- a/readme.md
+++ b/README.md
@@ -1,18 +1,50 @@
-# Lego Mindstorms EV3 MATLAB Toolbox
+# RWTH - Mindstorms EV3 Toolbox for MATLAB
Hello, fellow LEGO constructors and MATLAB programmers, welcome to the RWTH -
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,
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
-follow-up of the
-[RWTH MATLAB NXT Toolbox](http://www.mindstorms.rwth-aachen.de/).
+This toolbox is being developed at RWTH Aachen University, Germany. It is the
+successor of the
+[RWTH - MATLAB NXT Toolbox](http://www.mindstorms.rwth-aachen.de/). Amongst other applications,
+it is used in the yearly lab exercise ["MATLAB meets LEGO Mindstorms"](https://mindstorms.lfb.rwth-aachen.de)
+by more than 400 students in the first year of their Eletrical Engineering curriculum at RWTH Aachen University
+
+
+To get started, take a look at the installation instructions and examples below.
+
+
+## License
+
+This software is distributed under the Lesser GNU Plublic License v2.1 (LGPL 2.1).
-To get started, take a look at the installation instructions and examples.
+This software is based on the [QUT EV3 MATLAB Toolkit](https://wiki.qut.edu.au/display/cyphy/QUT+EV3+MATLAB+toolkit)
+by Peter Corke et al. of Queensland University. Source: <https://github.com/petercorke/robotics-toolbox-matlab/tree/master/interfaces/EV3>
+The QUT EV3 MATLAB Toolkit is part of the Robotics Toolbox for MATLAB, see:
+P. Corke, "Robotics, Vision \& Control: Fundamental Algorithms in Matlab", Springer, 2011, ISBN 978-3-642-20143
+
+This software uses the HIDAPI library by Alan Ott, Signal 11 Software, see <https://github.com/signal11/hidapi>
+
+## How to quote
+
+If you want to quote this software, you can use the following bibtex snippet:
+
+
+```bibtex
+@Misc{rwthmindstormsev3toolbox,
+ author = {Atorf, L. and Sondermann, B. and Stadtmann, T. and Rossmann, J.},
+ title = {RWTH - Mindstorms EV3 Toolbox},
+ year = {2018},
+ version = {1.0},
+ organization = {Institute for Man-Machine Interaction, RWTH Aachen University},
+ url = {https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab}
+}
+```
## Prerequisites
@@ -64,9 +96,8 @@ You can find more information on the toolbox functions/classes either by using
editor (the *.functionname* is optional), or in the PDF/HTML documentation
inside the subfolder *docs*.
-## Contribution
-### Building the documentation
+## Building the documentation
The documentation is built using [Sphinx](http://www.sphinx-doc.org/en/stable/) and several
extensions: [matlabdomain](https://pypi.python.org/pypi/sphinxcontrib-matlabdomain),
[Napoleon](https://pypi.python.org/pypi/sphinxcontrib-napoleon) and
--
GitLab