docs: add README to Doxyfile

Author: polesskiy-dev

.github/workflows/ci.yml

@@ -44,5 +44,7 @@ jobs:
         run: make -C test tests
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3
+        with:
+          verbose: true
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Doxyfile

@@ -906,7 +906,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src/
+INPUT                  = README.md src/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

README.md

@@ -25,7 +25,7 @@ Minimalistic implementation of Active Object pattern + FSM for embedded systems.
 
 Preprocessor templates allow strict typings and debugger suggestions, all types and enums have human-readable names, e.g. from [Request demo](./examples/request-fsm/README.md):
 
-![types](./docs/active-object-typings.png)
+![types](https://raw.githubusercontent.com/polesskiy-dev/active-object-fsm/main/docs/active-object-typings.png)
 
 TODO: make naming conventions e.g.: