This directory contains all the technical and process-related documentation for the project. Below is a table of contents to help you navigate through the different documents.
- Git Guidelines - Standards for commit messages, branching strategy, and pull requests.
- Git Workflow Guide - Detailed feature branching and release workflow.
- GitHub Actions Overview - CI/CD pipelines and automation overview.
- Pull Request Guide - Best practices for PR creation and review process.
- PiRacer Assembly Guide - Step-by-step guide to assemble the PiRacer vehicle.
- Initial Program Installation - Setup instructions for required software stack.
- Raspberry Pi System Setup - Configuration of Raspberry Pi OS and NVMe SSD setup.
- STM32 Motor Wiring - Wiring and hardware integration for motor control.
- VPN & Remote Access Guide - Remote access using NetBird and TigerVNC.
- Joystick Control - Python - Python-based joystick control implementation.
- Joystick Control - C++ - C++ implementation for vehicle control logic.
- Car Control Instructions - General car control setup and usage guide.
- Lane Detection Model ADR
- Object Detection Model ADR
- FSM Design (Decision System)
- Obstacle Avoidance ADR
- Lane Following Assist (LFA)
- Obstacle Avoidance System
- AGL (Automotive Grade Linux) - Embedded Linux platform integration and setup.
- Cross Compilation - Toolchain and cross-build environment.
- Energy Management - Energy analysis, consumption modeling and optimization.
- KUKSA - Vehicle signal and middleware integration.
- COVESA / VSS - Vehicle Signal Specification and conventions.
- uProtocol - Communication framework exploration.
- ThreadX RTOS - Real-time operating system documentation.
- Odometer System - Vehicle distance tracking system.
- Parking System - Autonomous parking logic and design.
- OTA / Instrument Cluster - Cluster and OTA-related systems.
- CARLA Simulator Setup - Setup and integration with CARLA simulator.
- C++ Linting Guide - Code quality and linting rules.
- C++ Tests - Unit and system testing guidelines.
- TSF Overview - Introduction to TSF methodology.
- TSF Concepts - Core TSF concepts.
- TSF Applied Guide - Practical application of TSF.
- ISO 26262 Structure - Functional safety foundation.
- Requirements & Assumptions - System requirements
- Decision Support - Engineering decisions and hazard analysis.
- Sprint Overview - Agile sprint structure and tracking.
- Sprint Reports - Detailed reports for each sprint iteration.
Sprints & Process
- Sprints - Contains all sprint reports and goals.