Improve arch documentation

* updated Doxygen configs
* added two READMEs for the test builds

arch/common/doc/doxygen-full.conf

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "REPARA FPGA API"
+PROJECT_NAME           = "TaPaSCo API"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = ../../../icon/tapasco_icon.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is

arch/common/doc/doxygen-header.conf

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "REPARA FPGA API"
+PROJECT_NAME           = "TaPaSCo API"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = ../../../icon/tapasco_icon.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -754,7 +754,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = README.md ../include/fpga_api.h
+INPUT                  = README.md ../include/tapasco_api.h ../include/tapasco_api.hpp
 
 # 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

arch/common/tests/README.md

+Unit tests for common libtapasco source fragments
+=================================================
+Some very simple unit test to check basic functionality. Requires libcheck [1].
+On Fedora: `sudo dnf install libcheck-devel`.
+Then `make && make test`.
+
+[1] https://libcheck.github.io/check/

arch/tests/README.md

+Debugging and benchmarking tools for TaPaSCo
+============================================
+Builds `tapasco-benchmark`, which generates a benchmark file for the host, and
+`tapasco-debug` which is an interactive debugging tool that can query the
+bitstream for functions, peek/poke and monitor registers and IRQ controllers.
+
+Building for benchmarking & debugging
+-------------------------------------
+Usual out-of-context build with CMake:
+
+`mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release && make && make install`
+
+The last puts the executables in `$TAPASCO_HOME/bin`, which makes them
+accessible anywhere after `setup.sh` was sourced.
+
+Building for debugging & dev
+----------------------------
+`mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Debug && make && make install`
+
+**NOTE: This carries an extreme performance penalty! Make sure you rebuilt in
+Release mode before running benchmarks!**