README.md

<!--
# Copyright (c) 2021-2023, Arm Limited.
#
# SPDX-License-Identifier: Apache-2.0
-->

# Safety Island Actuation Demo

A repository providing the elements to build the different components of the Safety Island Actuation 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.

### Generated files

The `.idl` files under `actuation_msgs/msg/` do not contain a copyright notice as they have been
generated by building the ROS2 and Autoware.Auto software stacks.
Specifically, with original message structures from the
rcl_interfaces(https://github.com/ros2/rcl_interfaces),
common_interfaces (https://github.com/ros2/common_interfaces) and
AutowareAuto (https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto) repositories.
Those repositories are provided under the Apache-2.0 License.

## Contact

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