sdk/codevis/README.md

0001 # Codevis
0002
0003 ![Codevis](doc/images/mainwindow.png)
0004
0005 [![build status](https://invent.kde.org/sdk/codevis/badges/master/pipeline.svg)](https://invent.kde.org/sdk/codevis/-/pipelines/?ref=master)
0006
0007 Codevis is an analysis and visualization tool designed to assist in code maintenance for C++ codebases.
0008
0009 The tool provides a graph representation of C++ source code and its external dependencies.
0010 It is aimed at developers working primarily with large codebases, who would benefit from being able to visualise
0011 source code in order to effectively understand it and its dependencies, for debugging their code or reviewing others' work.
0012
0013 This tool was developed by Codethink as part of a project sponsored by Bloomberg.
0014 The tool is based on John Lakos' ideas, which can be found in his books ("[Large Scale C++ Software Design](https://www.amazon.com/Large-Scale-Software-Design-John-Lakos/dp/0201633620/)"
0015 and "[Large Scale C++ Volume 1: Process and Architecture](https://www.amazon.com/Large-Scale-Architecture-Addison-Wesley-Professional-Computing/dp/0201717069/)"),
0016 as a means of displaying logical and physical entities.
0017
0018 ## Menu
0019
0020 - [Quick Start](#quick-start)
0021 - [Prebuilt binaries](#prebuilt-binaries)
0022 - [Building](#building)
0023 - [Contributions](#contributions)
0024 - [License](#license)
0025 - [Code of Conduct](#code-of-conduct)
0026 - [Security Vulnerability Reporting](#security-vulnerability-reporting)
0027
0028 ## Quick Start
0029
0030 See [Getting started](doc/getting_started.md) for information about using the tool.
0031 There's also [CLI documentation](doc/command_line_codebase_generation.md).
0032
0033 ## Prebuilt binaries
0034
0035 ### Windows:
0036
0037 Choose the Windows installer from the following list. The software is still being actively developed and there's no final release yet.
0038 If something crashes, please download the second file with the debug symbols and unpack at the binary folder of the installation so we can have backtraces.
0039
0040 - [**Windows (.exe)**](https://invent.kde.org/tcanabrava/codevis-binaries/-/tree/master/Windows)
0041
0042 ### Linux:
0043
0044 - [**CentOS7 CLI Tools only (.zip)**](https://invent.kde.org/tcanabrava/codevis-binaries/-/tree/master/Centos7)
0045 - [**Ubuntu 22.04 (.zip)**](https://invent.kde.org/sdk/codevis/-/wikis/uploads/77fc53bdc32d671ce8d27162f6b409d1/codevis-ubuntu-22.04.zip)
0046 - [**Ubuntu 20.04 (.zip)**](https://invent.kde.org/sdk/codevis/-/wikis/uploads/16c7045a6f17401a80652765bac3228a/codevis-ubuntu-20.04.zip)
0047
0048
0049 ## Building
0050
0051 To build the tool, follow the documentation for your operating system:
0052
0053 - [Linux](doc/build_linux.md)
0054 - [Windows](doc/build_windows.md)
0055 - [MacOS](doc/build_macos.md)
0056
0057 ## Contributions
0058
0059 We :heart: contributions.
0060
0061 Have you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?
0062
0063 We welcome issues reports. Just be sure to choose the proper issue template for your issue, so that we can be sure you're providing us with the necessary information.
0064
0065 Before sending a Pull Request, please make sure you read our [Contribution Guidelines](CONTRIBUTING.md).
0066
0067 ## License
0068
0069 Please read the [LICENSE](LICENSE).
0070
0071 ## Code of Conduct
0072
0073 This project has adopted a [Code of Conduct](CODE_OF_CONDUCT.md).
0074
0075 ## Security Vulnerability Reporting
0076
0077 Please refer to the project [Security Policy](SECURITY.md).