CoatiSoftware / Sourcetrail

Sourcetrail - free and open-source interactive source explorer
https://www.sourcetrail.com/
GNU General Public License v3.0
14.84k stars 1.39k forks source link

Create documentations to help get started #1172

Open anitsh opened 3 years ago

anitsh commented 3 years ago

Dear Sourcetrail Community Members,

First of all, I would like to thank Eberhard and the Sourcetrail team for this great project. Developers need such tools. The stars shows the importance itself.

I am not sure to raise this as an issue or just email the team about it but as I think many other who are looking forward to contribute to this project would benefit, I am raising this naive question here.

I am trying to understand Sourcetrail but I'm finding it a little bit hard. There do not seems to be any architectural document or smaller version of the code examples to get started. To understand things, I am scrapping any resource I find.

This presentation - C++Now 2018: Eberhard Gräther “The Untapped Potential of Software Visualization” indeed does add some superficial value but for developers who are looking forward to contribute would need more easy to understand resources.

The another documentation is for installation and application usage purpose only.

So I definitely believe if there was more easier way to understand the system that would be very much appreciated by many enthusiast in this tool and would be looking forward to contribute.

At the moment going through the code and I am trying to build and run Sourcetrail. I am on Ubuntu. I have downloaded the build from the documentation and ran the system previously but now I am more focused to understand how it works.

My concern is that I am a newbie in C++ and have not used QT framework. Learning C++ would be an issue though. The best to move forward would be learn QT and try to understand the system but I am trying to figure out faster way to learn how the system works in depth. The general for the visualization is done via parser, for Java Eclipse tools are used, and the data is rendered inside QT based web framework, I think chromium used inside of QT.

I am sincerely looking forward to the initiators and contributors suggestions and become an active contributor.

Thank you.