diff --git a/Docs/build_system.md b/Docs/dev/build_system.md similarity index 98% rename from Docs/build_system.md rename to Docs/dev/build_system.md index 59546b21c..9a360a294 100644 --- a/Docs/build_system.md +++ b/Docs/dev/build_system.md @@ -9,7 +9,7 @@ in the client-side. The goal is to be able to call Unreal Engine's functions from a separate Python process. -![modules](img/modules.png) +![modules](../img/modules.png) In Linux, we compile CARLA and all the dependencies with clang-7.0 and C++14 standard. We however link against different runtime C++ libraries depending on diff --git a/Docs/how_to_make_a_release.md b/Docs/dev/how_to_make_a_release.md similarity index 100% rename from Docs/how_to_make_a_release.md rename to Docs/dev/how_to_make_a_release.md diff --git a/Docs/how_to_upgrade_content.md b/Docs/dev/how_to_upgrade_content.md similarity index 100% rename from Docs/how_to_upgrade_content.md rename to Docs/dev/how_to_upgrade_content.md diff --git a/Docs/dev/index.md b/Docs/dev/index.md new file mode 100644 index 000000000..52143ec4b --- /dev/null +++ b/Docs/dev/index.md @@ -0,0 +1,6 @@ +

CARLA Development

+ + * [Map customization](map_customization.md) + * [Build system](build_system.md) + * [How to upgrade content](how_to_upgrade_content.md) + * [How to make a release](how_to_make_a_release.md) diff --git a/Docs/map_customization.md b/Docs/dev/map_customization.md similarity index 98% rename from Docs/map_customization.md rename to Docs/dev/map_customization.md index 5ab5a2b6d..f1fa1de60 100644 --- a/Docs/map_customization.md +++ b/Docs/dev/map_customization.md @@ -13,7 +13,7 @@ Creating a new map

Requirements

- - Checkout and build Carla from source on [Linux](how_to_build_on_linux.md) or [Windows](how_to_build_on_windows.md) + - Checkout and build Carla from source on [Linux](../how_to_build_on_linux.md) or [Windows](../how_to_build_on_windows.md)

Creating

@@ -25,7 +25,7 @@ Creating a new map - You can change the seed until you have a map you are satisfied with. - After that you can place new PlayerStarts at the places you want the cars to be spawned. - The AI already works, but the cars won't act randomly. Vehicles will follow the instructions given by the RoadMapGenerator. They will follow the road easily while in straight roads but wont so much when entering Intersections: -![road_instructions_example.png](img/road_instructions_example.png) +![road_instructions_example.png](../img/road_instructions_example.png) > (This is a debug view of the instructions the road gives to the Vehicle. They will always follow the green arrows, the white points are shared points between one or more routes, by default they order the vehicle to continue straight; Black points are off the road, the vehicle gets no instructions and drives to the left, trying to get back to the road) - To get a random behavior, you have to place IntersectionEntrances, this will let you redefine the direction the vehicle will take overwriting the directions given by the road map (until they finish their given order). diff --git a/Docs/index.md b/Docs/index.md index 940f95b39..f6a6b56bb 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -32,8 +32,6 @@ * [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 upgrade content](how_to_upgrade_content.md) - * [How to make a release](how_to_make_a_release.md)

Contributing

@@ -43,8 +41,11 @@

Development

- * [Map customization](map_customization.md) - * [Build system](build_system.md) + * [Index](dev/index.md) + * [Map customization](dev/map_customization.md) + * [Build system](dev/build_system.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

diff --git a/mkdocs.yml b/mkdocs.yml index 7e693d8c0..224121767 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,15 +28,16 @@ nav: - "Recorder binary file format": 'recorder_binary_file_format.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 upgrade content": 'how_to_upgrade_content.md' - - "How to make a release": 'how_to_make_a_release.md' - Contributing: - 'Contribution guidelines': 'CONTRIBUTING.md' - 'Coding standard': 'coding_standard.md' - 'Code of conduct': 'CODE_OF_CONDUCT.md' - Development: - - 'Map customization': 'map_customization.md' - - 'Build system': 'build_system.md' + - 'Index': 'dev/index.md' + - 'Map customization': 'dev/map_customization.md' + - 'Build system': 'dev/build_system.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'