search

ebourg / jsign

Java implementation of Microsoft Authenticode for signing Windows executables, installers & scripts
https://ebourg.github.io/jsign
Apache License 2.0
250 stars 107 forks source link

Add project map to README.md #166

Closed alexkarezin closed 7 months ago

alexkarezin commented 11 months ago

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/ebourgjsign/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project.

In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.

ebourg commented 11 months ago

Thank you for the suggestion. I see the value for complex projects, but Jsign has just a handful of modules, that's not that helpful.

The diagrams could be a bit clearer, some arrows are difficult to follow. Using only horizontal and vertical lines like IntelliJ dependency graph may be a good idea. And a different background for test dependencies is also worth considering.

image

alexkarezin commented 11 months ago

Emmanuel, thank you. I really appreciate the feedback. Let me take a last look at the whole set and try to address the concerns you raised. If you don't mind I'm going to ask for your opinion again later. Thanks again for a thorough writeup! @ebourg

ebourg commented 11 months ago

If you don't mind I'm going to ask for your opinion again later

Sure

Another suggestion: for Jsign no javadoc has been detected, I used to check it into the source tree but removed it recently, I rely on javadoc.io instead. Since sourcespy already parses the Maven pom it should be easy to link to javadoc.io.