Commit Graph

18 Commits

Author SHA1 Message Date
Robin Müller cbcfa8fe56 Merge remote-tracking branch 'upstream/development' into mueller/clang-shell-script 2021-12-06 15:06:05 +01:00
Robin Müller 15dddd7fc4
small README section for formatting 2021-12-01 16:17:27 +01:00
Robin Müller c2bf09d506 Introducing documentation with Sphinx
This PR introduces the generation of documentation based on
this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

It combines the tools Sphinx, Doxygen and Breathe to generate good
looking HTML documentation conveniently which can be hosted easily.

The helper scripts were unified and there is now one helper.py script
which can be used to create, build and open both tests and documentation.
"./helper.py -h" can be used to get the different options.

This PR also contains some smaller fixes which were necessary for the docs
to build
2021-12-01 11:17:28 +01:00
Robin Müller ad744fb593
README improvement 2021-10-11 15:56:04 +02:00
Robin Müller 6c75b56054
README update 2021-10-11 15:51:27 +02:00
Robin Müller ade15ad16d
tests can now be built as part of FSFW
This PR refactores the tests so they are built as part of the FSFW.
This is done by adding Catch2 with the FetchContent directive.

A future implementation might also use a system installation of Catch2
by first checking whether Catch2 can already be found as a package

The custom configuration folder testcfg was moved from the user folder
to the actual unittest folder.

The tests can be built by setting the CMake FSFW_BUILD_UNITTESTS option
to TRUE/ON. They are built with the static library and dropped inside
the build folders fsfw directory.
2021-10-07 13:24:46 +02:00
Robin Müller ec00a84b29
update README for moved logo 2021-08-03 18:46:50 +02:00
Robin Müller b7060a9c78
update README 2021-05-18 15:35:47 +02:00
Robin Müller 482f240995 doc update 2021-01-13 11:39:19 +01:00
Robin Müller 820731de7b updated docs, added new doc folder 2020-12-22 13:23:19 +01:00
Steffen Gaisser 64b6edab6f Update 'README.md' 2020-12-01 13:32:50 +01:00
Steffen Gaisser 4241c00448 Added the new logos, colors are WIP at the moment 2020-11-30 18:30:58 +01:00
Jakob Meier 227ec25e89 some minor corrections in readme 2020-11-27 11:44:11 +01:00
Steffen Gaisser 5b5f2f3e1d Added hardware recommendations 2020-11-17 09:42:38 +01:00
Steffen Gaisser 51443d7a68 Version number 2020-11-13 15:09:00 +01:00
Steffen Gaisser 8aef4b9b99 Updated formatting 2020-11-13 14:36:32 +01:00
Steffen Gaisser 752601e85f WIP readme 2020-11-13 14:31:30 +01:00
Robin Müller 247c9f2947 added readme 2020-10-20 17:39:11 +02:00