ADORe Technical Reference Manual
This document provides a table of contents for the ADORe Technical Reference Manual.
It links to all documents in this directory and gives a short description of their purpose.
About & General Information
- README.md — Overview of the ADORe project, goals, and background.
- contact.md — Contact information for maintainers and contributors.
- generated/CODE_OF_CONDUCT.md — Community guidelines for participation.
- generated/CONTRIBUTING.md — How to contribute to ADORe, including workflow and guidelines.
- document_admonition_templates.md — Templates for adding notes, warnings, and tips in documentation.
Getting Started
- getting_started/getting_started.md — Entry point for newcomers; explains the initial setup.
- getting_started/system_requirements.md — Minimum and recommended system specifications.
- getting_started/prerequisites.md — Required software and dependencies.
- getting_started/installing_docker.md — Instructions for setting up Docker for ADORe.
- quick_start.md — A fast setup and run guide for experienced users.
System and Development
- system_and_development/documentation.md — General documentation guidelines.
- system_and_development/creating_a_new_node.md — Guide for creating new ROS nodes.
- system_and_development/adore_cli.md — Command-line interface usage.
- system_and_development/anonymous_cloning.md — How to clone the repo without authentication.
- system_and_development/documentation_generation_system.md — How documentation is generated.
- system_and_development/doxygen_documentation.md — Generating Doxygen API documentation.
- system_and_development/multiarch_support.md — Multi-architecture build support.
- system_and_development/scenario_generation.md — How scenarios are generated for simulations.
ADORe ROS Components
- generated/ROS_NODES_SUMMARY.md — Summary of all ADORe ROS nodes.
- generated/adore_ros2_msgs/README.md — ADORe ROS2 message definitions.
- generated/adore_ros2_msgs/topics.md — ADORe ROS topic documentation.
ADORe User Libraries
- generated/libraries/README.md — Overview of ADORe user libraries.
- generated/libraries/library_creation_guide.md — Guide for creating new libraries.
- generated/libraries/cmake_library_auto_generation.md — CMake target/library auto-generation system.
ADORe REST API
- generated/api/adore_api/README.md — About the ADORe REST API.
- generated/api/adore_api/adore_mission_control.md — ADORe Mission Control web interface.
- generated/api/adore_api/api_reference.md — Complete API reference documentation.
- generated/api/adore_api/api_reference_curl_examples.md — API usage examples with curl.
Visualization
- generated/visualization/lichtblick/README.md — Scenario visualization with Lichtblick.
Modules & Submodules
- generated/modules/modules.md — Overview of ADORe modules and submodules.
Troubleshooting & Support
- problems_and_solutions.md — Troubleshooting common issues.
Licensing
- LICENSE — Full license text for the project.
- licensing.md — Summary of licensing terms.
- licensing/license_check.md — Steps to verify proper license headers in files.
- licensing/license_header_template.h — C/C++ license header template.
- licensing/license_header_template.md — Markdown license header template.
- licensing/license_header_template.txt — Text license header template.
- licensing/license_header_template.xml — XML license header template.
Publications & Development Guidelines
- publications.md — List of ADORe publications.
- styleguide.md — Coding and documentation style conventions.