Major feat(Documentation): Complete documentation rework

Split documentation into three folders: Architecture, Testing and
Installation.

Rework and expand architecture.md alongside interfaces.md

Split all parts to do with testing from Architecture md's into Test md's

Add parameter to ExamResultGenerator node documentation
This commit is contained in:
2025-10-08 16:30:05 +02:00
parent 130b495030
commit 5e1df5367c
15 changed files with 609 additions and 131 deletions

View File

@@ -0,0 +1,38 @@
## Installation
### Prerequisites
- ROS2 Jazzy or newer installed ([ROS2 Installation Guide](https://docs.ros.org/en/jazzy/Installation.html))
- CMake (version 3.8+)
- Python 3.8+
- libtomlplusplus-dev
- libpqxx-dev
- Colcon build tool
- Docker compose
### Clone the Repository
```bash
git clone https://git.wessel.gg/inholland/ros2-assignments.git
cd ros2-assignments
```
### Build the Workspace
```bash
colcon build
```
Any parameters can be changed before building by editing the `grade_calculator.launch.xml` in the launch folder
### Source the Workspace
```bash
source install/setup.bash
```
### Run the System
```bash
sudo docker-compose up
ros2 launch g2_2025_grade_calculator_pkg grade_calculator.launch.xml
```