From c9a4740164b7efa28b57e57eb542ec2f95cce0c1 Mon Sep 17 00:00:00 2001
From: Demian Frister <demian.frister@kit.edu>
Date: Mon, 19 Sep 2022 12:29:58 +0000
Subject: [PATCH] Readme erste Fassung erstellt

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 815dfdf..0a52077 100644
--- a/README.md
+++ b/README.md
@@ -10,4 +10,55 @@ ROS: noetic
 
 
 Robots: 
- - Panda
\ No newline at end of file
+ - Panda
+
+ Features:
+
+ - ROS Noetic
+ - Ros für Franka Panda
+ - MoveIt vorkompiliert
+
+
+
+## Installation
+
+### lokale Windows installation
+1. Visual Studio Code
+(Erläuterung: https://code.visualstudio.com/docs/remote/containers)
+2. WSL 
+    (https://learn.microsoft.com/de-de/windows/wsl/install)
+3. Docker https://docs.docker.com/desktop/install/windows-install/
+4. Erstellt euch einen Fork von dem Repository
+5. Cloned das Repository in die WSL Umgebung (git clone ...)
+6. Öffnet das Repository in Visual Studio code mit "code ." in dem Repository Ordner.
+7. Führt mit strg + shift + p "Remote-Containers: Open in Container" aus. Ihr seid nun in der Umgebung mit allen benötigten Paketen.
+
+
+### auf dem Roboter PC
+
+1. Erstellt euch einen Fork von dem Repository
+2. Cloned das Repository in die WSL Umgebung (git clone ...)
+3. Öffnet das Repository in Visual Studio code mit "code ." in dem Repository Ordner.
+4. Führt mit strg + shift + p "Remote-Containers: Open in Container" aus. Ihr seid nun in der Umgebung mit allen benötigten Paketen.
+
+### Funktionen:
+
+#### Desktopumgebung
+Geht in eurem Browser auf: http://localhost:6080/. Mit dem Passwort: "vscode" könnt ihr die Desktopumgebung des Systems im Container aufrufen.
+Alle Fenster die ihr im Container öffnet, werden hier sichtbar. 
+
+#### Panda Gazebo
+
+Mit dem Befehl:
+'roslaunch franka_gazebo panda.launch x:=-0.5 \
+    world:=$(rospack find franka_gazebo)/world/stone.sdf \
+    controller:=cartesian_impedance_example_controller \
+    rviz:=true'
+öffnet ihr einen Simulator + Visualisierer vom Panda Roboter mit einem kartesischen Impedanz Controller. Es sind nun alle RosTopics geladen um den (virtuellen) Roboter zu steuern.
+
+
+### Eigenen Code erstellen: 
+
+Um ein eigenes ROS Package zu erstellen müsst ihr ein catkin package in /workspace/catkin_ws/src erstellen (oder reinclonen). http://wiki.ros.org/ROS/Tutorials/CreatingPackage
+
+mit "catkin_make" in /workspace/catkin_ws wird dieses Package kompiliert und alle Funktionen stehen zur Verfügung nachdem ihr mit source /workspace/catkin_ws/devel/setup.bash den Workspace gesourced habt.
\ No newline at end of file
-- 
GitLab