From 5067b9109e32801b6f6e0f95455f4d4174547e5c Mon Sep 17 00:00:00 2001 From: nsubiron Date: Fri, 22 Dec 2017 18:38:10 +0100 Subject: [PATCH] Add benchmark to documentation --- Docs/{carla_benchmark.md => benchmark.md} | 4 ++++ Docs/index.md | 1 + mkdocs.yml | 1 + 3 files changed, 6 insertions(+) rename Docs/{carla_benchmark.md => benchmark.md} (89%) diff --git a/Docs/carla_benchmark.md b/Docs/benchmark.md similarity index 89% rename from Docs/carla_benchmark.md rename to Docs/benchmark.md index b42279752..64c536607 100644 --- a/Docs/carla_benchmark.md +++ b/Docs/benchmark.md @@ -1,6 +1,10 @@ CARLA Benchmark =============== +!!! important + Benchmark code is currently in beta and can be found only in the + `benchmark_branch`. + Running the Benchmark --------------------- diff --git a/Docs/index.md b/Docs/index.md index 1eb92cb1a..560a4078f 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -8,6 +8,7 @@ CARLA Documentation * [CARLA settings](carla_settings.md) * [Measurements](measurements.md) * [Cameras and sensors](cameras_and_sensors.md) + * [Benchmark](benchmark.md) * [F.A.Q.](faq.md) * [Troubleshooting](troubleshooting.md) diff --git a/mkdocs.yml b/mkdocs.yml index 20ed2da28..204cff558 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ pages: - 'CARLA Settings': 'carla_settings.md' - 'Measurements': 'measurements.md' - 'Cameras and sensors': 'cameras_and_sensors.md' + - 'Benchmark': 'benchmark.md' - 'F.A.Q.': 'faq.md' - 'Troubleshooting': 'troubleshooting.md' - Building from source: