Skip to content

Commit

Permalink
Added requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilianoHFlores committed Mar 24, 2024
1 parent 7c0ccde commit 5eb9faa
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,23 @@ And to update the submodules content execute:
git submodule update --init --recursive
```

All the development environments use Docker, follow the instructions below or the README inside the `docker` folder for insights.
All the development environments use Docker, follow the instructions below or the [README](docker/README.md) inside the `docker` folder for insights.

## Software Architecture

![home-2](https://github.com/RoBorregos/home/assets/25570636/ea6f9551-27c7-4b4e-8fcb-8733a6eb7284)

## Docker Development
The project uses Docker for easier development within ROS and CUDA/Jetson compatibility. Both this main engine repository and each area's contain a `docker` folder with dockerfiles and a Makefile for easier image and container creation.
### Requirements

The project uses Docker for easier development within ROS and CUDA/Jetson compatibility. Both this main engine repository and each area's contain a `docker` folder with dockerfiles and a Makefile for easier image and container creation. To build an image, run:
- [Docker Engine](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
- [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/)
If using GPU:
- NVIDIA Driver
- [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/index.html))
### Container Creation
To build an image, run:

```bash
# For CPU
Expand All @@ -37,7 +45,7 @@ make main.build.cuda
# For Jetson L4T: 35.4.1
make main.build.jetson
```
To create a container, run the following commands. The `ws` folder is mounted by default, and additional folders can be added with the `volumes` argument, with both absolute and relative paths:
To create a container, run the following commands. The `ws` folder is mounted by default, and additional folders can be added with the `volumes` argument, with both absolute and relative paths allowed:

```bash
# For CPU
Expand All @@ -62,7 +70,7 @@ make main.down
make main.remove
```

Additional commands can be added with the Makefile and the scripts inside the `docker/scripts` folder can help for easier integration and sharing.
Additional commands can be added within the Makefile and the scripts inside the `docker/scripts` folder can help for easier integration and sharing.

## Team Members

Expand Down

0 comments on commit 5eb9faa

Please sign in to comment.