This folder provides example files to start a new project configuration.
Please refer to the documentation for details on how to create a working
project configuration.

The contents of this folder are:

Templates for start scripts to run a server or local analysis run

- start_analysis.bat        (Windows)
- start_analysis.sh         (Linux/MacOS with bash)

Note: environment variables defined in the start scripts are used in the provided
configuration files. For compiler configuration, note that the generated configs must
match the toolchain name.

** Project configuration templates for C and C++ projects:

cpp/
cpp/axivion_config.json             Template Interface Layer config. Please add
                                    required layers to the list in this file.

cpp/ci_config.json                  Project template for C/C++ projects with some
                                    default build steps

cpp/compiler_config.json            Template for compiler configuration. Please add
                                    your specific config for cafeCC to this file, or
                                    generate the file with the <<compiler>>setup
                                    scripts.
                                    
cpp/additional_compiler_config.json Template for additional compiler configuration as
                                    additional layer, so that you can re-generate the
                                    compiler_config.json above.

cpp/rule_config_c.json              Configuration layer for C projects
                                    with a selection of rules and config options

cpp/rule_config_cpp.json            Configuration layer for C++ projects
                                    with a selection of rules mostly based on
                                    AUTOSAR C++ and some common config options

cpp/rule_config.py                  Template configuration layer to modify the
                                    configuration using the Python API. This
                                    is usually added directly before the
                                    rule_config.json in _Layers list in
                                    axivion_config.json.

cpp/config_filter_compiler_warnings.py
                                    Example configuration layer that shows how
                                    to disable compiler warnings
cpp/config_allman_braces.py         Example configuration layer that shows how
                                    to configure Allman Braces


** Project configuration templates for C# projects:

csharp/
csharp/axivion_config.json          Template Interface Layer config. Please add
                                    required layers to the list in this file.
csharp/ci_config.json               Project template for C# projects with some
                                    default build steps
cpp/rule_config_csharp.py           Template configuration layer to modify the
                                    configuration using the Python API.
cpp/rule_config_cpp.json            Configuration layer for C# projects
                                    with a selection of frequently-used rules


** General purpose templates

generic/
generic/gravis2.config              Configuration for Gravis, see comment inside
generic/example_metric.py           Template for development of customer metric


** Configuration for architecture check based on Enterprise Architect Models

ea/config_ea_architecture.py        Template for a configuration layer


** Configuration for architecture check based on Rhapysody Models

rh/
rh/config_rh_architecture.py        Template for a configuration layer
rh/export_architecture.bat          Batch file to export model into GXL file