Add linter and licence (#6)

* Add linter and licence stuff

* Update package

[skip ci]

* Fix linter stuff

LICENSE.md

@@ -0,0 +1,11 @@
+Copyright (c) 2019, The Personal Robotics Lab, The MuSHR Team, The Contributors of MuSHR
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docker/Dockerfile

@@ -1,5 +1,6 @@
 FROM schmittle/mushr_sim:stable
 
+USER root
 #replace with your uid/gid
 RUN export uid=1001 gid=1001 && \
     echo "developer:x:${uid}:${gid}:Developer,,,:/home/developer:/bin/bash" >> /etc/passwd && \

package.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <package format="2">
   <name>mushr_sim</name>
-  <version>0.0.0</version>
-  <description>Mushr sim package, created by Patrick Lancaster</description>
+  <version>1.0.0</version>
+  <description>A simulator for the MuSHR car. Created by Patrick Lancaster</description>
 
   <maintainer email="[email protected]">schmittle</maintainer>
   <maintainer email="[email protected]">Matthew Rockett</maintainer>

src/fake_urg_node.py

@@ -1,5 +1,8 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2019, The Personal Robotics Lab, The MuSHR Team, The Contributors of MuSHR
+# License: BSD 3-Clause. See LICENSE.md file in root directory.
+
 import numpy as np
 import range_libc
 import rospy

src/fake_vesc_driver_node.py

@@ -1,5 +1,8 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2019, The Personal Robotics Lab, The MuSHR Team, The Contributors of MuSHR
+# License: BSD 3-Clause. See LICENSE.md file in root directory.
+
 import rospy
 from std_msgs.msg import Float64
 from vesc_msgs.msg import VescStateStamped

src/keyboard_teleop.py

@@ -1,10 +1,13 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2019, The Personal Robotics Lab, The MuSHR Team, The Contributors of MuSHR
+# License: BSD 3-Clause. See LICENSE.md file in root directory.
+
 import atexit
 import os
 import signal
 from threading import Lock
-from Tkinter import Frame, Tk
+from Tkinter import Frame, Label, Tk
 
 import rospy
 from ackermann_msgs.msg import AckermannDriveStamped
@@ -120,6 +123,13 @@ def main():
     frame.bind("<KeyRelease>", keyup)
     frame.pack()
     frame.focus_set()
+    lab = Label(
+        frame,
+        height=10,
+        width=30,
+        text="Focus on this window\nand use the WASD keys\nto drive the car.\n\nPress Q to quit",
+    )
+    lab.pack()
     print("Press %c to quit" % QUIT)
     root.mainloop()
 

src/utils.py

@@ -1,5 +1,8 @@
 #!/usr/bin/env python
 
+# Copyright (c) 2019, The Personal Robotics Lab, The MuSHR Team, The Contributors of MuSHR
+# License: BSD 3-Clause. See LICENSE.md file in root directory.
+
 import numpy as np
 import tf
 import tf.transformations