codevis/lvtclp/README.md

0001 # BDE Codebase Database Creation Tool
0002
0003 # Introduction
0004
0005 Parses the classes in C++ source and creates a SQLite database for the application to visualise.
0006
0007 The parser learns about a project through a `compile_commands.json` file,
0008 generated by CMake. For a simple CMake project, this can be generated by adding
0009 the `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to your cmake invocation.
0010
0011 Code is parsed using clang so it is best to configure your build to use clang.
0012 This can be configured in CMake using the `CC` and `CXX` environment variables.
0013 Bugs parsing code configured for other compilers have not been observed for bde
0014 but this is possible where compiler-specific features are used.
0015
0016 ## Steps to parse BDE (or any project built using bde-tools)
0017 See doc/command_line_codebase_generation.md