Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some context around the installation procedure and the png file generation procedure #22

Open
tappoz opened this issue Oct 25, 2018 · 0 comments

Comments

@tappoz
Copy link

tappoz commented Oct 25, 2018

Could it be possible to be a bit more verbose in the README.md when explainin the compilation/installation process? Like saying the output of the compilation is just a binary/blob called make2graph. This would help people using Makefiles, but not used to the build/compilation process of C projects.

Also mentioning some common/standard practices like putting that binary in /usr/local/bin on Unix environments (or any other viable/sensible place in $PATH) helps in giving a bit of context for people not used to compile C projects from source code.

I see there's a bash script called makefile2graph that perhaps could/need to be placed somewhere else (available in $PATH). I am assuming this bash script should automagically take care of locale issues, a bit of context around that locale thing and where to "install it" in a canonical place could help.

Regarding the pipe example into dot to generate a png image: a bit of context around graphviz could help in understanding what that dot command is doing, as the logical connection between dot and the graphviz context was not clear to me and querying a web search engine for "dot png" did not help. In my case on Debian I had to run sudo apt-get install graphviz to then install the dot command.

Thanks for this great visual tool, I find it very helpful when building projects made by a combination of different programming languages, cloud infrastructure building processes, remote deployments in cloud providers, and remote monitoring tools for the build process :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant