Merge pull request #211 from Kapim/devel

Devel

.gitmodules

@@ -14,10 +14,6 @@
 	path = arcor2_AREditor/Submodules/Unity3DRuntimeTransformGizmo
 	url = https://github.com/xBambusekD/Unity3DRuntimeTransformGizmo.git
 	ignore = dirty
-[submodule "arcor2_AREditor/Submodules/usfb"]
-	path = arcor2_AREditor/Submodules/usfb
-	url = https://github.com/adrenak/usfb.git
-	ignore = dirty
 [submodule "arcor2_AREditor/Submodules/RosSharp"]
 	path = arcor2_AREditor/Submodules/RosSharp
 	url = https://github.com/xBambusekD/ros-sharp.git

README.md

@@ -1,8 +1,25 @@
-# arcor2_editor
-ARCOR2 AR Editor
+# ARCOR2 AREditor
 
+**ARCOR** stands for **A**ugmented **R**eality **C**ollaborative **R**obot. It is a system for simplified programming of collaborative robots based on augmented reality developed by [Robo@FIT](https://www.fit.vut.cz/research/group/robo/.en).
+
+This repository contains the main user interface, Unity-based client application for ARCore-supported tablets: AREditor. The backend part of the solution is available [here](https://github.com/robofit/arcor2).
+
+Development is supported by [Test-it-off: Robotic offline product testing](https://www.fit.vut.cz/research/project/1308/) project (Ministry of Industry and Trade of the Czech Republic).
+
+<p align="center">
+<img src="https://user-images.githubusercontent.com/1199396/109945741-d77c6a00-7cd7-11eb-9eb0-0448e346b60a.jpg" width="250" alt="Main menu with overview of scene, projects and execution packages."/>
+<img src="https://user-images.githubusercontent.com/1199396/109945708-d0555c00-7cd7-11eb-9e7a-eeee34b3acab.jpg" width="250" alt="AREditor being used to program Dobot M1."/>
+<img src="https://user-images.githubusercontent.com/1199396/109945756-dba88780-7cd7-11eb-8b95-49175dcbcc72.jpg" width="250" alt="VR mode."/>
+</p>
+
+### Installation
+
+With each [release](https://github.com/robofit/arcor2_areditor/releases), we are building Android apk which can be simply installed on a supported device, which is any [ARCore compatible tablet](https://developers.google.com/ar/discover/supported-devices#google_play_devices). We use primarily Samsung devices (S6, S7). There are also Linux/Windows binaries, but mainly for testing and debugging purposes (no AR).
+
+### Development
+
+These are instructions for developers.
 
-### Instalation
  - clone this repo
  - get submodules:
    ```bash
@@ -33,8 +50,10 @@ ARCOR2 AR Editor
    - [UI Graph](https://assetstore.unity.com/packages/tools/gui/ui-graph-51304)
    - [Joystick Pack](https://assetstore.unity.com/packages/tools/input-management/joystick-pack-107631)
    - [Native Camera for Android & iOS](https://assetstore.unity.com/packages/tools/integration/native-camera-for-android-ios-117802) (only if you want to build Android version)
+   - [Trilib 2](https://assetstore.unity.com/packages/tools/modeling/trilib-2-model-loading-package-157548) - manually delete folder Trilib/Plugins/NewtonSoft.Json/ otherwise, there will be most likely conflicts
    - [Simple Collada](https://assetstore.unity.com/packages/tools/input-management/simple-collada-19579)
      - requires to apply patch (<b>/scripts/ColladaImporter.patch</b> and <b>/scripts/StringExtensions.patch</b>) on script ColladaImporter.cs and OrbCreationExtensions/StringExtensions.cs
+     - SimpleCollada asset must be moved to Assets/Submodule folder in order to patch script works
      - on Windows, you can download [UnxUtils](http://unxutils.sourceforge.net/) and use batch file in /scripts/patch_simple_collada_asset.bat (if UnxUtils extracted to "C:\Program Files\") or use this command:
      ```bash       
      path_to_UnxUtils\UnxUtils\usr\local\wbin\patch.exe ..\arcor2_AREditor\Assets\Submodules\SimpleCollada\ColladaImporter.cs -i ColladaImporter.patch