dependency graph

[smanders]

it would be helpful to have a graphviz (.dot) dependency graph for the projects in externpro

eventually maybe the .dot can be cmake-generated?

I also don't want to commit a binary image (.png) to the repo as that would bloat the repo over time - so I've been exploring options to render the .dot file into the README.md file...

to create a png file:

dot -Tpng -odeps.png deps.dot

[smanders]

I put all the code in place to update the projects/README.md with a dependency graph

externpro/modules/xpfunmac.cmake

Lines 606 to 626 in 9265bfa

	if(EXISTS ${PRO_DIR}/deps.dot AND XP_GRAPH_DEPS)
	set(user smanders)
	set(branch dev)
	set(mark customgraph01)
	set(url "https://raw.githubusercontent.com/${user}/externpro/${branch}/projects/README.md")
	string(REPLACE "/" "%2F" url ${url})
	string(REPLACE ":" "%3A" url ${url})
	file(APPEND ${g_README}
	"\n\n## dependency graph\n\n"
	"\n"
	"<details>\n"
	"<summary></summary>\n"
	"${mark}\n"
	)
	file(READ ${PRO_DIR}/deps.dot depsDotDot)
	file(APPEND ${g_README}
	"${depsDotDot}"
	"${mark}\n"
	"</details>\n"
	)
	endif()

but also require a -DXP_GRAPH_DEPS to be defined to actually modify the README.md

externpro/modules/xpfunmac.cmake

Line 606 in 9265bfa

if(EXISTS ${PRO_DIR}/deps.dot AND XP_GRAPH_DEPS)

the reason for making it a little tricky to modify the README.md is because I'm not satisfied with the hard-coded user and branch name required in the url

externpro/modules/xpfunmac.cmake

Line 610 in 9265bfa

set(url "https://raw.githubusercontent.com/${user}/externpro/${branch}/projects/README.md")

[smanders]

include graphviz graphs in github README.md

• https://github.com/TLmaK0/gravizo
• http://g.gravizo.com/

info regarding attempts to not have hard-coded user and branch name in the url

• relative links in markup files https://blog.github.com/2013-01-31-relative-links-in-markup-files/
• github link to wiki page from README https://stackoverflow.com/questions/23789542/github-link-to-wiki-page-from-readme

github/markup requests that could help

• request for placeholders for branch name, user/organization name Placeholder for branch name in readme.md file github/markup#913
• request for relative raw links Relative Raw Links github/markup#1172
• request to add automated diagrams Add automated diagrams github/markup#1199

[smanders]

completed with commits referenced above to dev branch

[smanders]

seems I should remove the XP_GRAPH_DEPS check... it's too easy to not have that defined, then it removes the dependency graph from the projects/README.md and: dirtyrepo

so I'll take it out for now, live with it there for awhile, see what I think of the dependency graph in the readme and if I end up taking it out of the readme (because of the hard-coded user and branch name) then I'll reintroduce XP_GRAPH_DEPS so it's a bit harder to inject the dependency graph into the readme