Skip to content

Commit 47dedd1

Browse files
committed
Add basic documentation
1 parent 0220883 commit 47dedd1

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,51 @@
55
[![ROS Version Jazzy](https://img.shields.io/badge/ROS%20Version-Jazzy-00b8ff)](https://docs.ros.org/en/jazzy/index.html)
66

77
This git repository contains all RoboCup-related code and documentation from the Hamburg Bit-Bots team.
8-
All code is written as individual ROS 2 packages targeting Ubuntu.
8+
All code is written as individual ROS 2 packages.
99

1010
<p align="center">
1111
<img width="30%" src="logo.png" alt="Bit-Bots Logo" />
1212
</p>
1313

1414
## Installation
1515

16+
The workspace is managed using the [pixi](https://pixi.sh) package manager. This allows us to have reproducible builds and easy user space dependency management similar to tools like `uv` or `cargo`. This also means that no system wide ROS installation or superuser privileges are required to install or run the code.
17+
1618
Full step-by-step instructions for installing the Bit-Bots software stack and ROS 2 can be found in our documentation [here](https://doku.bit-bots.de/meta/manual/tutorials/install_software_ros2.html).
1719

1820

19-
Run the following command to install all dependencies and clone all necessary repositories. Make sure you have [just](https://just.systems/) and correct ROS 2 version installed.
21+
Run the following command inside this repository to build the workspace. All dependencies will be installed automatically. Make sure you have [pixi](https://pixi.sh) installed. A few optional proprietary dependencies will be needed for full functionality, see the documentation for details.
2022

2123
``` shell
22-
just install
24+
pixi run build
2325
```
2426

25-
## Building
27+
## Using the workspace
2628

27-
To build the code, run
29+
To activate the workspace run the following command in the terminal you want to use:
2830

2931
``` shell
30-
just build
32+
pixi shell
3133
```
3234

33-
and source the setup file with
35+
alternatively, you can run individual commands inside the workspace without activating the shell:
3436

3537
``` shell
36-
. install/setup.sh
38+
pixi run <command>
3739
```
3840

39-
To see all available recipes, run
41+
To see some predefined tasks, run
4042

4143
``` shell
42-
just -l
44+
pixi run -v
4345
```
4446

4547
## Run auto formatting
4648

4749
To format all code in the repository, run
4850

4951
``` shell
50-
just format
52+
pixi run format
5153
```
5254

5355
## More documentation

0 commit comments

Comments
 (0)