Skip to content

Commit 7c337e9

Browse files
committed
docs: Initial commit to add basic set up tutorial to README.md
Refs colcon#12
1 parent 7077009 commit 7c337e9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,31 @@
44

55
An extension for [colcon-core](https://github.com/colcon/colcon-core) to
66
support Rust projects built with Cargo.
7+
8+
## Basic Set Up
9+
This introduction assumes the following dependencies are already installed:
10+
- python >= 3.5
11+
- rust/cargo are installed
12+
- colcon (comes with ros2 core distribution)
13+
14+
#### Install colcon_cargo
15+
`pip install -U git+https://github.com/colcon/colcon-cargo.git`
16+
#### Create two cargo crates
17+
Navigate to a workspace where you want to start creating packages and run the following commands:
18+
```
19+
cargo new hello_world
20+
cargo new hello_world_2
21+
```
22+
23+
#### Build with colcon
24+
```colcon build```
25+
26+
You should get output that looks like this:
27+
```
28+
Starting >>> hello_world
29+
Starting >>> hello_world_2
30+
Finished <<< hello_world_2 [1.84s]
31+
Finished <<< hello_world [1.94s]
32+
33+
Summary: 2 packages finished [2.34s]
34+
```

0 commit comments

Comments
 (0)