mirror of
https://gitlab.dit.htwk-leipzig.de/phillip.kuehne/dezibot.git
synced 2025-05-18 18:41:47 +02:00
merged markdown documents for doxy input
This commit is contained in:
parent
84a0a379d6
commit
3f175e6b75
11
README.md
11
README.md
@ -1,9 +1,16 @@
|
||||
# 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
|
||||
|
||||
This repository contains the Library for the Dezibot4.<br>
|
||||
It is ment to serve as an Arduino-Library. Therefore the rules for arduinolibrary develop apply:<br>
|
||||
The project focuses on the software for the Dezibot4 robot and its use in the classroom.<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)
|
||||
* [Libraryspecification](https://arduino.github.io/arduino-cli/0.35/library-specification/)
|
||||
|
@ -830,7 +830,6 @@ WARN_LOGFILE =
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = . \
|
||||
doxymain.md \
|
||||
README.md
|
||||
|
||||
# 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
|
||||
# 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
|
||||
|
@ -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)
|
Loading…
x
Reference in New Issue
Block a user