README.md

# Autoware Safety Island Demo

A repository providing the elements to build the different components of the Autoware on Safety Island demo.

## Documentation

Prior to building the documentation locally, the following packages need to be installed on the host:

```bash
sudo apt-get install python3-pip
pip3 install -U sphinx==4.0.2 sphinx_rtd_theme==0.5.2 sphinx-copybutton==0.4.0 docutils==0.16
echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc ; source ~/.bashrc  # only if not already in PATH
```

To build and generate the documentation in html format, run:

```bash
sphinx-build -b html -a -W documentation public
```

To render and explore the documentation, simply open public/index.html in a web browser.

## Repository License

The software is provided under an Apache-2.0 license.

License details may be found in the [local license file](license.rst), or as
part of the project documentation.

Contributions to the project should follow the same license.

## Contact

Please see the project documentation for the list of maintainers, as well as the
process for contributions, bug reports, feedback and support.