Skip to content

Commit ada034d

Browse files
committed
[Documentation] Update installation
1 parent c9fb502 commit ada034d

4 files changed

Lines changed: 39 additions & 30 deletions

File tree

docu/Environment_setup.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Setup the environment and start the eclipse application
2+
3+
### 0: Start the ROS tooling application
4+
5+
:bangbang::bangbang: This is only needed if you installed the toolig from [source](#option-2-using-the-eclipse-installer---source-installation-ros-tooling-developers), if you installed the release version please continue directly with the [step 1](#1-switch-to-the-ros-developer-perspective)
6+
7+
select de.fraunhofer.ipa.ros.plugin and press the button *Run*
8+
9+
![alt text](images/run_ros_tooling.png)
10+
11+
### 1: Switch to the ROS Developer perspective
12+
13+
Go to Menu Window -> Perspective -> Open Perspective -> Other... -> ROS developer. Your application toolbar will be automatically configured.
14+
15+
### 2: Import the common communication objects project
16+
17+
import the project located under the "ROSCommonObjects" folder of this repository to the workbench of your application:
18+
```
19+
de.fraunhofer.ipa.ros.communication.objects
20+
```
21+
22+
If you have internet a button can clone from GitHub the objects to your workspace and import them automatically:
23+
24+
![alt text](images/clone_and_import.png)
25+
26+
Now that your workspace is setup, you can start creating your [project and defining your ROS system](#Tutorials)

docu/Installation.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
### Option 1: Using the Release version (Recommended)
44

5-
The first step is to install eclipse. Please download the installer from the official eclipse [website](https://www.eclipse.org/downloads/packages/installer). Once you start the installer, select the package "Eclipse Modeling Tools".
5+
First the java environment have to be setup:
6+
7+
```
8+
sudo apt-get install openjdk-19-jre
9+
```
10+
11+
Then Eclipse can be installes. Please download the installer from the official eclipse [website](https://www.eclipse.org/downloads/packages/installer). Once you start the installer, select the package "Eclipse Modeling Tools".
612

713
![alt text](images/install_eclipse_modeling.png)
814

@@ -13,11 +19,15 @@ Press next, and then pick the java version 19 and the folder where you would lik
1319
Continue the installation, acepting the license, as usual.
1420

1521
Once the installation is completed, go to *Help* > *Install New Software...*. To install the latest version of the ROS tooling, add the update site URL [https://raw.githubusercontent.com/ipa320/RosTooling-update-site/main](https://raw.githubusercontent.com/ipa320/RosTooling-update-site/main)(*) in the *Work with* section.
22+
1623
![alt text](images/install_updatesite.png)
1724

1825
If none package is listed, please uncheck the option *Group items by category*. The category *ROS Model* appears in the *Name* area. Check the box in front of *ROS model* and click *Next* to review the list of items to be installed. Click *Next* again to read and accept the terms of the license agreements and afterwards click *Finish*. Eclipse will then start to install the ROS tooling and its dependencies. If you get a security warning about the authenticity, click OK. Finally, when asked, restart Eclipse to complete the installation process.
1926

20-
To start using the ROS tooling continue with the [step 1](#1-switch-to-the-ros-developer-perspective)
27+
To start using the ROS tooling continue with the [step 1](Environment_setup.md/#1-switch-to-the-ros-developer-perspective)
28+
29+
30+
## Alternative installations
2131

2232
### Option 2: Using the Eclipse Installer - Source installation (ROS tooling developers)
2333

@@ -50,31 +60,4 @@ By default the ROS tooling installation will be saved under the folder *ros-mode
5060

5161
Follow the installation instructions of the Oompth installer dialog, after the installation eclipse will be restarted to launch the ROS tooling configuration. Finally, when all the startup tasks finished press "Workbench".
5262

53-
To start using the ROS tooling continue with the [step 0](#0-start-the-ros-tooling-application)
54-
55-
# Setup the environment and start the eclipse application
56-
57-
### 0: Start the ROS tooling application
58-
59-
:bangbang::bangbang: This is only needed if you installed the toolig from [source](#option-2-using-the-eclipse-installer---source-installation-ros-tooling-developers), if you installed the release version please continue directly with the [step 1](#1-switch-to-the-ros-developer-perspective)
60-
61-
select de.fraunhofer.ipa.ros.plugin and press the button *Run*
62-
63-
![alt text](images/run_ros_tooling.png)
64-
65-
### 1: Switch to the ROS Developer perspective
66-
67-
Go to Menu Window -> Perspective -> Open Perspective -> Other... -> ROS developer. Your application toolbar will be automatically configured.
68-
69-
### 2: Import the common communication objects project
70-
71-
import the project located under the "ROSCommonObjects" folder of this repository to the workbench of your application:
72-
```
73-
de.fraunhofer.ipa.ros.communication.objects
74-
```
75-
76-
If you have internet a button can clone from GitHub the objects to your workspace and import them automatically:
77-
78-
![alt text](images/clone_and_import.png)
79-
80-
Now that your workspace is setup, you can start creating your [project and defining your ROS system](#Tutorials)
63+
To start using the ROS tooling continue with the [step 0](Environment_setup.md/#0-start-the-ros-tooling-application)
16.4 KB
Loading

docu/images/install_updatesite.png

-15.1 KB
Loading

0 commit comments

Comments
 (0)