diff --git a/README.md b/README.md index 1479eb2e28e42757b1681e7328c21741a20b619b..1891688e33dff7a7d563f00228f2dc624aada393 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# mdBook Documentation - -This is a repository to store the documentation of the BPSE - AI at the edge project in the form of markdown files and automatically deploy those to gitlab pages using the CI pipeline. +# AI at the Edge +This is the main repository of the AI at the edge project. This repository is used to store the documentation in the form of markdown files and various jupyter notebooks. +The markdown files are used to automatically create a website using mdbook which is then deployed to gitlab pages using the CI/CD pipeline. The actual mdbook can be found in the [book](./book) directory and the accompanying jupyter notebooks can be found in the [notebooks](./notebooks) directory. -The deployed documentation can be found [here](https://pse-ai-at-the-edge.h-da.io/ai-at-the-edge/). +**The deployed documentation can be found [here](https://pse-ai-at-the-edge.h-da.io/ai-at-the-edge/).** +## Secondary repositories +As part of this project we offer an ansible script as well as a raspberry pi image for setup of the project environment. For these two subprojects we have separate repositories. +- [pi-gen fork for image building](https://code.fbi.h-da.de/pse-ai-at-the-edge/image-builder) +- [Ansible script](https://code.fbi.h-da.de/pse-ai-at-the-edge/raspberry-pi-setup) \ No newline at end of file diff --git a/book/book.toml b/book/book.toml index fd30223ec3885d2c260e9cd31114777cadc0e00d..ec1f08bd0ebfe3b9023d923cc707dbf4d4cd4f39 100644 --- a/book/book.toml +++ b/book/book.toml @@ -1,5 +1,5 @@ [book] -authors = ["Andreas Marius Weber","Daniel Müller","Felix Matthias Krumm","Kai-Philipp Nosper","Kevin de Riese-Meyer","Lukas Pfahlert","Niklas Speckels","Tobias Stein"] +authors = ["Daniel Müller","Felix Matthias Krumm","Kai-Philipp Nosper","Kevin de Riese-Meyer","Lukas Pfahlert","Niklas Speckels","Tobias Stein"] language = "en" multilingual = false src = "src"