README.md

CodeCompass

CodeCompass is a pluginable code comprehension tool.

💡 Live demo on LLVM source code available here

Screenshots

Features

• User friendly web UI
• Fast navigation among source code elements
• Several languages supported
• Deep parsing for C, C++, Java and more is coming
• Many diagrams: call path, inheritance, aggregation, CodeBites, etc.
• Scalable: Quick response time even for large (100Mb) source code base

Documentations

• Backend user guide
• Frontend user guide
• Docker guide

Development

• Building CodeCompass
• Frontend development guide
• Coding conventions