Updated readme for liscense and doi

Author: tgroechel

LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2020 Thomas Groechel
+
+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.
+

README.md

@@ -0,0 +1,59 @@
+# MoveToCode: A Mixed Reality Visual Programming Language
+
+MoveToCode is an open source mixed reality visual programming language (VPL) created by the [Interaction Lab](http://robotics.usc.edu/interaction/) led by [Maja J Matric](https://robotics.usc.edu/~maja/index.html). The VPL is used to study [student kinesthetic curiostiy](https://tgroechel.github.io/kin_cur.html).  The VPL can be thought of similar to [Scratch](https://scratch.mit.edu/) in 3D. 
+
+MoveToCode is built for the [Microsoft Hololens 2](https://www.microsoft.com/en-us/hololens/hardware) using the [Mixed Reality Toolkit](https://github.com/microsoft/MixedRealityToolkit-Unity). Currently it is set up to work with the [Mayfield Kuri robot](https://www.heykuri.com/explore-kuri/) but can be modified for any [ROS](https://www.ros.org/) supported robot via [ROS#](https://github.com/siemens/ros-sharp) and [rosbridge](http://wiki.ros.org/rosbridge_suite).
+
+Here is a [video](https://www.youtube.com/watch?v=s7udZXa2wEw) of MoveToCode + a robot tutor.
+
+## Study Commits
+Currently the study commit for all papers: [0765f1d1ab46373f1bc1be90d9d5b07fafc2a533](https://github.com/interaction-lab/MoveToCode/commit/0765f1d1ab46373f1bc1be90d9d5b07fafc2a533)
+
+## Projects in Progress
+- Arrays
+- CodeBlock to Python Text
+- Robot speech via Amazon Polly
+- [Adding virtual robot arms](https://github.com/interaction-lab/KuriAugmentedRealityArmsPublic)
+
+## General Structure
+
+### Interpreter
+- Singleton class that reads/interprets connected codeblocks line-by-line from top to bottom, beginning at the "Start" codeblock.
+- Utilizes an instruction stack to ensure that the reaching the end of a codeblock control flow statement (if, while) does not end the program unless the stack is empty.
+
+### Memory Manager
+- Singleton class that holds a list of buttons which spawn variables created by the user.
+- Visualizes changes in the values stored in variables as interpreter reads/runs code.
+
+### IArgument
+- Abstract class from which all visual/block coding components are derived.
+- Of all the classes that inherit from IArgument, only the bottom classes/leaf nodes are non-abstract
+- Child classes - main partition for code blocks based on function
+    - IDataType: All data types (primitive and derived) inherit from this class
+        - int, float, string, bool, char, array
+    - Instruction: All instructions inherit from this class
+        - print, set variable value, conditionals, arithmetic
+
+
+## External Dependencies
+Versions of packages are pushed directly to the repository to avoid versioning issues, licensing permitting.
+- [ROS#; dwhit UWP branch](https://github.com/dwhit/ros-sharp/commit/4ccf45fc94827132397afeaa210afc01834d1dec) ([Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
+    - [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) ([MIT License](https://en.wikipedia.org/wiki/MIT_License))
+    - [Newtonsoft.Json.Bson](https://github.com/JamesNK/Newtonsoft.Json.Bson) ([MIT License](https://en.wikipedia.org/wiki/MIT_License))
+    - [websocket-sharp](https://github.com/sta/websocket-sharp) ([MIT License](https://en.wikipedia.org/wiki/MIT_License))
+- [Mixed Reality Toolkit v2.1](https://github.com/microsoft/MixedRealityToolkit-Unity)([MIT License](https://en.wikipedia.org/wiki/MIT_License))
+- [ProBuilder](https://github.com/Unity-Technologies/com.unity.probuilder) ([Unity Companion License](https://unity3d.com/legal/licenses/Unity_Companion_License))
+- [TextMeshPro](https://docs.unity3d.com/Packages/com.unity.textmeshpro@2.0/manual/index.html) ([Unity Companion License](https://unity3d.com/legal/licenses/Unity_Companion_License))
+
+## Tested Platform Support
+The following are currently tested versions of required software. Higher versions of each software may work but have not been tested.
+- [Unity 3D](https://github.com/siemens/ros-sharp/tree/master/Unity3D) v2018.4.14f
+- .NET Framework 4.6 and Visual Studio 2017
+- Built for [Hololens 2](https://www.microsoft.com/en-us/hololens/hardware)
+
+## Licensing
+MoveToCode is open source under the [MIT License](https://en.wikipedia.org/wiki/MIT_License)
+
+
+## Questions or Contributions
+For any questions, you can contact Thomas Groechel at groechel@usc.edu. Feel free to fork for your own projects and/or submit pull requests.