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

Update README.md by adding a link to repository map #57

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

alexkarezin
Copy link
Contributor

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/blueconicbrowscapjava/). 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.

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/blueconicbrowscapjava/). 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.
@alexkarezin
Copy link
Contributor Author

@paulrutter
Paul, any chance you can take a look? I'm wondering if you see this being useful and how can it be improved. Thanks!

@paulrutter
Copy link
Contributor

Hi @alexkarezin,

Can you elaborate a bit on what you're trying to achieve?
The diagrams look useful at first sight.

And what about licensing, how is your project licensed?

@alexkarezin
Copy link
Contributor Author

Hey @paulrutter, the goal of the project is to provide (and automatically maintain) an easy-to-undersand visual representation of BrowsCap internals.

Specifically:

For BrowsCap contributors, the diagrams provide an interactive introduction to the project structure (which contirbutors need to understand before they get their hands 'dirty').

For BrowsCap users, the diagrams provide a piece of mind of knowing what comes into solution they are integrating with (I guess we all want to know what's inside even if we are not planning to change it).

The documentation engine is a project that me and my partner support and maintain. It has been used by numerous GH projects. The documentation itself can be licensed under MIT/Apache2/... BrowsCap maintainer's preference. I would assume MIT would suite best.

Hope this helps, let me know if I can provide more clarity.
Thank you!

@paulrutter paulrutter merged commit 62a6ea5 into blueconic:master Sep 19, 2023
@paulrutter
Copy link
Contributor

I merged it in, thanks for the PR.

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

Successfully merging this pull request may close these issues.

None yet

2 participants