Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.01 KB

File metadata and controls

52 lines (35 loc) · 2.01 KB

Autoware Documentation

Autoware Foundation Logo
Deploy Docs License

The central documentation hub for the Autoware open-source autonomous driving platform.

📖 Read the Documentation


About

This repository contains the source files for Autoware's documentation, built and deployed with MkDocs. Autoware spans multiple repositories, and this site serves as a unified entry point to access information across all of them.

For more about the Autoware project and its ecosystem, see the Autoware Foundation organization profile.

Getting started locally

# Clone the repository
git clone https://github.com/autowarefoundation/autoware-documentation.git
cd autoware-documentation

# Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
pip install -r mkdocs-requirements.txt

# Serve locally
mkdocs serve

Then open http://localhost:8000 in your browser.

Contributing

Contributions are welcome! Please review the documentation guidelines before submitting a pull request.

License

This project is licensed under the Apache License 2.0.