https://github.com/kde/codevis

Codevis is an analysis and visualization tool designed to assist in code maintenance for C++ codebases.
https://github.com/kde/codevis

Last synced: 4 days ago
JSON representation

Codevis is an analysis and visualization tool designed to assist in code maintenance for C++ codebases.

• Host: GitHub
• URL: https://github.com/kde/codevis
• Owner: KDE
• License: other
• Created: 2023-08-17T10:53:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-07T11:26:46.000Z (8 days ago)
• Last Synced: 2024-11-07T12:28:45.434Z (7 days ago)
• Language: C++
• Homepage: https://invent.kde.org/sdk/codevis
• Size: 27.6 MB
• Stars: 18
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# Codevis

![Codevis](doc/images/mainwindow.png)

[![build status](https://gitlab.com/CodethinkLabs/codevis/codevis/badges/main/pipeline.svg)](https://gitlab.com/CodethinkLabs/codevis/codevis/-/pipelines/?ref=main)

Codevis is an analysis and visualization tool designed to assist in code maintenance for C++ codebases.

The tool provides a graph representation of C++ source code and its external dependencies.

It is aimed at developers working primarily with large codebases, who would benefit from being able to visualise

source code in order to effectively understand it and its dependencies, for debugging their code or reviewing others' work.

This tool was developed by Codethink as part of a project sponsored by Bloomberg.

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/)"

and "[Large Scale C++ Volume 1: Process and Architecture](https://www.amazon.com/Large-Scale-Architecture-Addison-Wesley-Professional-Computing/dp/0201717069/)"),

as a means of displaying logical and physical entities.

## Menu

- [Quick Start](#quick-start)

- [Building](#building)

- [Contributions](#contributions)

- [License](#license)

- [Code of Conduct](#code-of-conduct)

- [Security Vulnerability Reporting](#security-vulnerability-reporting)

## Quick Start

See [Getting started](doc/getting_started.md) for information about using the tool.

There's also [CLI documentation](doc/command_line_codebase_generation.md).

## Building

To build the tool, follow the documentation for your operating system: 

- [Linux](doc/build_linux.md)

- [Windows](doc/build_windows.md)

- [MacOS](doc/build_macos.md)

## Contributions

We :heart: contributions.

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?

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.

Before sending a Pull Request, please make sure you read our [Contribution Guidelines](CONTRIBUTING.md).

## License

Please read the [LICENSE](LICENSE).

## Code of Conduct

This project has adopted a [Code of Conduct](CODE_OF_CONDUCT.md).

## Security Vulnerability Reporting

Please refer to the project [Security Policy](SECURITY.md).