From 3f175e6b75053e74b5e8e434bbc83c5e92c9e2ad Mon Sep 17 00:00:00 2001 From: "Prof.J.Wagner" Date: Thu, 6 Jun 2024 20:44:18 +0200 Subject: [PATCH] merged markdown documents for doxy input --- README.md | 11 +++++++++-- doxygen.txt | 3 +-- doxymain.md | 3 --- 3 files changed, 10 insertions(+), 7 deletions(-) delete mode 100644 doxymain.md diff --git a/README.md b/README.md index 75e2509..c77beff 100644 --- a/README.md +++ b/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.
-It is ment to serve as an Arduino-Library. Therefore the rules for arduinolibrary develop apply:
+The project focuses on the software for the Dezibot4 robot and its use in the classroom.
+It includes libraries for use by students as well as guides for teachers. The hardware of the robot is not part of the project.
+The libraries and example programs are available under the GPL and are accessible as a repository.
+It is ment to serve as an Arduino-Library.
+Therefore the rules for arduinolibrary develop apply:
* [Styleguide](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide) * [Libraryspecification](https://arduino.github.io/arduino-cli/0.35/library-specification/) diff --git a/doxygen.txt b/doxygen.txt index 344b559..b3c1889 100644 --- a/doxygen.txt +++ b/doxygen.txt @@ -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 diff --git a/doxymain.md b/doxymain.md deleted file mode 100644 index a1d10a9..0000000 --- a/doxymain.md +++ /dev/null @@ -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)