|
|
This is a guide to help you get the project running locally on your computer. It supposes the reader is running Linux, but since we're using Docker you should be able to get it working either way. Since VS Code is the most popular editor in-house right now, I'll also show you how to get some niceties such as code completion through the use of [dev containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
|
|
|
This is a guide to help you get up and running locally. Since VS Code is the most popular editor in-house right now, I'll also show you how to get some niceties such as code completion through the use of [dev containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
|
|
|
|
|
|
Start by cloning down this repository and follow the steps found [here](./Docker) to get the container images setup. If you're only interested in one subsystem (such as `lhw_qi`) you will only have to build the base image plus that subsystem's image.
|
|
|
# Before starting
|
|
|
- I'm on Linux, but you should be able to get it running even if you aren't.
|
|
|
- It won't explain docker.
|
|
|
- It won't explain any ROS concepts.
|
|
|
|
|
|
# Setup the project
|
|
|
Let us suppose you want to do some changes inside of the `lhw_qi` subsystem (if you're interested in any other subsystem, just replace `lhw_qi` with it from now on). Start by cloning down the project repository to your local PC somewhere, `git clone git@gitlab.liu.se:liuhomewreckers/liu-home-wreckers.git`. Now follow the steps found [here](./Docker) to get the container images setup. You'll only have to build for `lhw` and `lhw_qi`.
|
|
|
|
|
|
To check whether everything works as it should, you can enter the container with `docker compose run --rm lhw_qi zsh` and then execute `colcon build`. It should take about 4 minutes to complete the compilation.
|
|
|
|
|
|
# Making changes
|
|
|
... |
|
|
\ No newline at end of file |