phillip/dezibot
1
0
Fork 0
mirror of https://gitlab.dit.htwk-leipzig.de/phillip.kuehne/dezibot.git synced 2025-05-19 02:51:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

merged markdown documents for doxy input

Browse Source
This commit is contained in:
Prof.J.Wagner 2024-06-06 20:44:18 +02:00
parent 84a0a379d6
commit 3f175e6b75
3 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,9 +1,16 @@
# Dezibot4 Lib # Dezibot4 Lib
## Links to external documentation
* [PDF-Doku Code](https://hardwarelabor.imn.htwk-leipzig.de/dezibot/dezibot.pdf)
* [PDF-Doku Device](https://hardwarelabor.imn.htwk-leipzig.de/dezibot/dezibot-4doku.pdf)
## Introduction ## Introduction
This repository contains the Library for the Dezibot4.<br> The project focuses on the software for the Dezibot4 robot and its use in the classroom.<br>
It is ment to serve as an Arduino-Library. Therefore the rules for arduinolibrary develop apply:<br> It includes libraries for use by students as well as guides for teachers. The hardware of the robot is not part of the project.<br>
The libraries and example programs are available under the GPL and are accessible as a repository.<br>
It is ment to serve as an Arduino-Library.<br>
Therefore the rules for arduinolibrary develop apply:<br>
* [Styleguide](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide) * [Styleguide](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide)
* [Libraryspecification](https://arduino.github.io/arduino-cli/0.35/library-specification/) * [Libraryspecification](https://arduino.github.io/arduino-cli/0.35/library-specification/)

3
doxygen.txt
View File

@ -830,7 +830,6 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = . \ INPUT = . \
doxymain.md \
README.md README.md
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
@ -1027,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub # (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output. # and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = doxymain.md USE_MDFILE_AS_MAINPAGE = README.md
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to source browsing # Configuration options related to source browsing

3
doxymain.md
View File

@ -1,3 +0,0 @@
# Dezibot4 library
* [PDF-Doku Code](https://hardwarelabor.imn.htwk-leipzig.de/dezibot/dezibot.pdf)
* [PDF-Doku Device](https://hardwarelabor.imn.htwk-leipzig.de/dezibot/dezibot-4doku.pdf)