diff --git a/PythonAPI/carla/README.md b/PythonAPI/carla/README.md new file mode 100644 index 000000000..727cc58f6 --- /dev/null +++ b/PythonAPI/carla/README.md @@ -0,0 +1,5 @@ +This is the Python package for the CARLA Python API used for controlling and communicating-with [CARLA](https://carla.org) - The open-source simulator for autonomous driving research. + +This package allows you to control the CARLA simulator and retrieve simulation data through the Python API. For instance, you can control any actor (vehicle, pedestrian, traffic light, etc...) in the simulation, attach sensors to vehicles, and read the sensor data etc. + +For more information, refer to the [Guide for getting started with CARLA](https://carla.readthedocs.io/en/latest/getting_started/). diff --git a/PythonAPI/carla/setup.py b/PythonAPI/carla/setup.py index 5967d244f..755d024bc 100755 --- a/PythonAPI/carla/setup.py +++ b/PythonAPI/carla/setup.py @@ -157,6 +157,9 @@ def get_license(): return 'LGPL-v2.1-only License' return 'MIT License' +with open("README.md") as f: + long_description = f.read() + setup( name='carla', version='0.9.11', @@ -165,6 +168,8 @@ setup( ext_modules=get_libcarla_extensions(), license=get_license(), description='Python API for communicating with the CARLA server.', + long_description=long_description, + long_description_content_type='text/markdown', url='https://github.com/carla-simulator/carla', author='The CARLA team', author_email='carla.simulator@gmail.com',