Browse Source

added license file and authors to the authors list

asobolev 3 years ago
parent
commit
8031b2dffc
2 changed files with 27 additions and 4 deletions
  1. 21 0
      LICENSE
  2. 6 4
      README.md

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jan Küster
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 6 - 4
README.md

@@ -24,12 +24,11 @@ Once the environment has been activated, install R, its essentials, and the kern
 
 Finally, for the notebooks to run, you will have to install additional python modules and R libraries and their dependencies to your environment. Notebooks may not run smoothly, if the wrong versions of the modules are installed. Especially having the wrong versions of openCV can cause trouble, which is why we provide the Jupyter notebooks that run on Python 3 for two different versions of openCV (3.4.2 & 4.0.1). The code below will install the latest version of the modules/libraries to your environment. Version numbers in brackets are the latest module/library versions the notebooks were tested with (5th of Febuary, 2020).
 
-**Python modules:** numpy (1.18.1), openCV (3.4.2 or 4.0.1), tkinter (8.6.8), xlxswriter (1.2.7), scipy (1.3.2), sounddevice (0.3.14), pyfirmata (1.1.0)
+**Python modules:** numpy (1.18.1), openCV (3.4.2 or 4.0.1), tkinter (8.6.8), scipy (1.3.2), sounddevice (0.3.14), pyfirmata (1.1.0)
 
     conda install numpy
     conda install opencv
     conda install tk
-    conda install xlsxwriter
     conda install scipy
     conda install -c conda-forge python-sounddevice
     conda install -c conda-forge pyfirmata
@@ -47,11 +46,14 @@ To work with the different notebooks, select the folder to which you downloaded
 
 ## Authors
 
-* **Daniel Schmidtke** 
+* **Daniel Schmidtke**
+* **Diana Amaro**
+* **Andrey Sobolev**
 
 ## License
 
-This project is licensed under the MIT License (see the license file **TODO** for details). 
+This project is licensed under the MIT License (see the license file for details).
+
 ## Acknowledgments
 
 * The implemented tracking algorithm was inspired by **colinlaney**'s animal-tracking at: https://github.com/colinlaney/animal-tracking