diff --git a/Docs/index.md b/Docs/index.md index 8bcbfb63d..2a3412ec1 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -1,100 +1,209 @@

CARLA Documentation

+Welcome to the CARLA documentation. + +This page contains the index with a brief explanation on the different sections for clarity. +Feel free to explore the documentation on your own, however, here are a few tips for newcomers: + +* __Install CARLA__: visit the [Quickstart installation](../dev/quickstart) to get the CARLA releases or make the build for a desired platform. +* __Start using CARLA__: there is a section titled [First steps](../core_concepts), highly recommended for newcomers. +* __Doubts on the API__: there is a handy [Python API reference](../python_api) to consult classes and methods. + +Besides that, there is also the CARLA forum where the community gathers to share issues, suggestions and solutions: +
+ +CARLA forum +
+ !!! important - This documentation refers to the latest development versions of CARLA, 0.9.0 - or later. For the documentation of the stable version please switch to the - [stable branch](https://carla.readthedocs.io/en/stable/). + This is documentation for CARLA 0.9.0 or later. Previous documentation is in the [stable branch](https://carla.readthedocs.io/en/stable/). +--------------- -
- -
- ------------

Getting started

- Brief summary on CARLA. - Also how to install the releases. -
-

- Introduction -
- Quickstart installation +

+ + Introduction + + — Capabilities and intentions behind the project. + + Quickstart installation + + — Get the CARLA releases.

- -
- -
- ------------

Building CARLA

- Install the CARLA build on Linux or Windows. - Update CARLA - - Introduction -
- Quickstart installation +

+ + Linux build + + — Make the build on Linux. + + Windows build + + — Make the build on Windows. + + Update CARLA + + — Get up to date with the latest content. + + Build system + + — Learn about the build and how it is made. + + Running in a Docker + + — Run CARLA using a container solution. + + F.A.Q. + + — Some of the most frequent issues for newcomers. +

+

First steps

+

+ + Core concepts + + — Overview of the basic concepts in CARLA. + + 1st. World and client + + — Manage and access the simulation. + + 2nd. Actors and blueprints + + — Learn about actors and how to handle them. + + 3rd. Maps and navigation + + — Discover the different maps and how to move around. + + (broken) 4th. Sensors and data + + — Retrieve simulation data using sensors. +

Advanced steps

+

+ + Recorder + + — Store all the events in a simulation a play it again. + + Rendering options + + — Different settings, from quality to no-render or off-screen runs. + + Synchrony and time-step + + — Client-server communication and simulation time. + + (broken) Traffic manager + + — Feature to handle autopilot vehicles and emulate traffic. -

+

References

+

+ + Python API reference + + — Classes and methods in the Python API. + + Code recipes + + — Code fragments commonly used. + + Blueprint library + + — Blueprints provided to spawn actors. + + C++ reference + + — Classes and methods in CARLA C++. + + Recorder binary file format + + — Detailed explanation of the recorder file format. + + (broken) Sensors reference + + — Everything about sensors and the data they retrieve. -

+

Tutorials — General

+

+ + Add friction triggers + + — Define dynamic box triggers for wheels. + + Control vehicle physics + + — Set runtime changes on a vehicle physics. + + Control walker skeletons + + — Skeleton and animation for walkers explained. - - - - - - - - -
QuickstartHello
AB
this is my caption
+

Tutorials — Assets

+

+ + Contribute with new assets + + — Add new content to CARLA. + + Import new assets + + — Use personal assets in CARLA. + + Map customization + + — Edit an existing map. + + Map creation + + — Guidelines to create a new map. + + Standalone asset packages + + — Import assets into Unreal Engine and prepare them for package distribution. + + Use Automotive materials + + — Apply Epic's set of Automotive materials to vehicles for a more realistic painting. + + Vehicle modelling + + — Guidelines to create a new vehicle for CARLA. -

Quick start

- - * [Python API tutorial](core_concepts.md) - * [Rendering options](rendering_options.md) - * [Simulation time and synchrony](simulation_time_and_synchrony.md) - * [Cameras and sensors](core_sensors.md) - * [F.A.Q.](faq.md) - -

Building from source

- - * [How to build on Linux](how_to_build_on_linux.md) - * [How to build on Windows](how_to_build_on_windows.md) - -

Advanced topics

- - * [Python API reference](python_api.md) - * [C++ Reference](cpp_reference.md) - * [Python Cookbook](python_cookbook.md) - * [Blueprint Library](bp_library.md) - * [Running without display and selecting GPUs](carla_headless.md) - * [Running in a Docker](carla_docker.md) - * [How to create and import a new map](how_to_make_a_new_map.md) - * [How to link Epic's Automotive Materials](epic_automotive_materials.md) - * [Creating standalone asset packages for distribution](asset_packages_for_dist.md) - * [How to add friction triggers](how_to_add_friction_triggers.md) - * [How to control vehicle physics](how_to_control_vehicle_physics.md) - * [How to record and replay](recorder_and_playback.md) - * [Recorder binary file format](recorder_binary_file_format.md) - * [How to control walker skeletons](walker_bone_control.md) +

Tutorials — Developers

+

+ + Create a sensor + + — The basics on how to add a new sensor to CARLA. + + Make a release + + — For developers who want to publish a release. + + Pedestrian navigation physics + + — Generate the information needed for walkers to navigate a map.

Contributing

- - * [Contribution guidelines](CONTRIBUTING.md) - * [Coding standard](coding_standard.md) - * [Documentation standard](doc_standard.md) - * [Code of conduct](CODE_OF_CONDUCT.md) - -

Development

- - * [Index](dev/index.md) - * [Map customization](dev/map_customization.md) - * [Build system](dev/build_system.md) - * [How to add a new sensor](dev/how_to_add_a_new_sensor.md) - * [How to upgrade content](dev/how_to_upgrade_content.md) - * [How to make a release](dev/how_to_make_a_release.md) - -

Art guidelines

- - * [How to add assets](how_to_add_assets.md) - * [How to model vehicles](how_to_model_vehicles.md) +

+ + General guidelines + + — The different ways to contribute to CARLA. + + Coding standard + + — Guidelines to write proper code. + + Documentation standard + + — Guidelines to write proper documentation. + + Code of conduct + + — Some standards for CARLA, rights and duties for contributors. \ No newline at end of file