Skip to content

Commit 009b75a

Browse files
A few typos and minor improvements
1 parent 4c79637 commit 009b75a

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

docs/GettingStarted.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# Getting Started
22

33
RoboStack is a bundling of ROS for Linux, macOS and Windows using the [Conda package manager](https://docs.conda.io/en/latest/), based on top of [conda-forge](https://conda-forge.org/).
4-
We have also extended support to the [Pixi](https://pixi.sh/latest/) package manager, which builds upon the foundations of, and maintains compatabillity with the Conda ecosystem.
4+
We have also extended support to the [Pixi](https://pixi.sh/latest/) package manager, which builds upon the foundations of, and maintains compatability with the Conda ecosystem. [Here](https://pixi.sh/dev/switching_from/conda/) is a comparison of how Pixi works when compared to Conda/Mamba.
55

6-
[Here](https://pixi.sh/dev/switching_from/conda/) is a comparison of how Pixi works when compared to Conda/Mamba
7-
8-
You can install Robostack using either Mamba or pixi.
6+
You can install Robostack using either Mamba or Pixi. We recommend using Pixi for any new installations.
97
=== "Mamba"
108
## Install Mamba
119
To get started, you'll need a base conda installation. We recommend using the [`miniforge`](https://github.com/conda-forge/miniforge) installer.
@@ -22,7 +20,7 @@ You can install Robostack using either Mamba or pixi.
2220
Make sure to _not_ install the ROS packages in your base environment as this leads to issues down the track. On the other hand, conda and mamba must not be installed in the `ros_env`, they should only be installed in base.
2321
2422
!!! warning "Do not source the system ROS environment"
25-
When there is an installation available of ros on the system, in non-conda environments, there will be interference with the environments. As the `PYTHONPATH` set in the setup script conflicts with the conda environment.
23+
When there is an installation available of ros on the system, in non-conda environments, there will be interference with the environments as the `PYTHONPATH` set in the setup script conflicts with the conda environment.
2624

2725
!!! warning "PowerShell is not supported"
2826

@@ -153,7 +151,7 @@ You can install Robostack using either Mamba or pixi.
153151
After installation, you may need to restart your terminal for the `pixi` command to be available.
154152

155153
!!! warning "Do not source the system ROS environment"
156-
When there is an installation available of ROS on the system, in non-conda environments, there will be interference with the environments. As the `PYTHONPATH` set in the setup script conflicts with the conda environment.
154+
When there is an installation available of ROS on the system, in non-conda environments, there will be interference with the environments as the `PYTHONPATH` set in the setup script conflicts with the conda environment.
157155

158156

159157
## Install RoboStack using Pixi
@@ -175,7 +173,7 @@ You can install Robostack using either Mamba or pixi.
175173
platforms = ["linux-64", "win-64", "osx-64", "osx-arm64", "linux-aarch64"]
176174

177175
[target.win-64.dependencies]
178-
#vs2022_win-64 = "*" #Uncomment if using Visual Studio 2022
176+
# vs2022_win-64 = "*" # Uncomment if using Visual Studio 2022
179177

180178
[dependencies]
181179
python = "*"
@@ -184,13 +182,14 @@ You can install Robostack using either Mamba or pixi.
184182
pkg-config = "*"
185183
make = "*"
186184
ninja = "*"
185+
libgl-devel = "*"
187186

188187
[environments]
189188
noetic = { features = ["noetic"] }
190189
humble = { features = ["humble"] }
191190
jazzy = { features = ["jazzy"] }
192191

193-
#noetic
192+
# noetic
194193
[feature.noetic]
195194
channels = ["https://prefix.dev/robostack-noetic"]
196195

@@ -199,7 +198,7 @@ You can install Robostack using either Mamba or pixi.
199198
catkin_tools = "*"
200199
rosdep = "*"
201200

202-
#humble
201+
# humble
203202
[feature.humble]
204203
channels = ["https://prefix.dev/robostack-humble"]
205204

@@ -208,7 +207,7 @@ You can install Robostack using either Mamba or pixi.
208207
colcon-common-extensions = "*"
209208
rosdep = "*"
210209

211-
#jazzy
210+
# jazzy
212211
[feature.jazzy]
213212
channels = ["https://prefix.dev/robostack-jazzy"]
214213

@@ -218,23 +217,22 @@ You can install Robostack using either Mamba or pixi.
218217
rosdep = "*"
219218
```
220219
```bash
221-
#Save and exit pixi.toml
220+
# Save and exit pixi.toml
222221
pixi install
223-
#You can now start an environment with your desired robostack distribution using one of the below commands (either executed from within the project directory or by appending `--manifest-path` and pointing to your project directory):
222+
# You can now start an environment with your desired robostack distribution using one of the below commands (either executed from within the project directory or by appending `--manifest-path` and pointing to your project directory):
224223

225-
#ROS noetic
224+
# ROS noetic
226225
pixi shell -e noetic
227226

228-
#ROS humble
227+
# ROS humble
229228
pixi shell -e humble
230229

231-
#ROS jazzy
230+
# ROS jazzy
232231
pixi shell -e jazzy
233-
234232
```
235233

236234
## Testing installation
237-
After installation, you should test if you are able to run `rviz` and other ros tools.
235+
After installation, you should test if you are able to run `rviz`/`rviz2` and other ROS tools.
238236

239237
!!! note "Reminder"
240238
The ROS environment activation is included automatically. There is no need to add a `source` command in the `~/.bashrc`
@@ -338,7 +336,7 @@ After installation, you should test if you are able to run `rviz` and other ros
338336
**ROS2**
339337
```bash title="Terminal"
340338
cd robostack
341-
pixi shell -e humble #OR jazzy
339+
pixi shell -e humble # OR jazzy
342340
rviz2
343341
```
344342

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy