diff --git a/README.md b/README.md index 77e588dca7d91bbe9b8e8d0eb70343696b853f32..036eae8b34775d7630bb1d6aed456c12b6ec1402 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,11 @@ References Contents ======== -1. About the Project -2. File Structure -3. Developer Guides - 1. Adding a Device - 2. Implementing a Driver +1. [About the Project](#1-about-the-project) +2. [File Structure](#2-file-structure) +3. [Developer Guides](#3-developer-guides) + 1. [Adding a Device](#31-adding-a-device) + 2. [Implementing a Driver](#32-implementing-a-driver) -------------------------------------------------------------------------------- @@ -75,7 +75,7 @@ The files are structured as follows: - [`./`](./)<br/> The project root directory contains [this file](./README.md), a [`license.html`](./license.html) file as well as a make script [`amiro-lld.mk`](./amiro-lld.mk) that allows to easily integrate the project. Furthermore, two interface headers are provided: [`amiro-lld.h`](./amiro-lld.h) and [`periphAL.h`](./periphAL.h). -- [`./docs/`](.(docs/)<br/> +- [`./docs/`](./docs/)<br/> UML graphs (using PlantUML; see <https://plantuml.com> for further information) visualize the structure of the AMiRo-LLD project. Doxygen related files can be used to generate a documentation of the whole project (wip). - [`./drivers/`](./drivers/)<br/>