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

We need an overview document describing available, "supported" Kaleidoscope modules. #165

Closed
obra opened this issue Aug 9, 2017 · 6 comments
Labels

Comments

@obra
Copy link
Member

obra commented Aug 9, 2017

This document should include end-user friendly capsule descriptions of known, moderately-trusted Kaleidoscope plugins, as well as links to those plugins usage documentation.

It should include author and maintainer information for each plugin.

We can probably steal the content from https://asylum.madhouse-project.org/blog/2017/03/10/rose-tinted-glasses/ to get started. (With @algernon's permission)

This issue partially replaces #162

@algernon
Copy link
Contributor

algernon commented Aug 9, 2017

You can steal that content, it's under CC-BY-SA 3.0. I'm willing to relicense it to something else reasonable if another license would fit the result better. (GPL, GFDL come to mind as example licenses I'd be happy with.)

@obra
Copy link
Member Author

obra commented Aug 9, 2017 via email

@algernon
Copy link
Contributor

What if we made this automated? Go through Arduino-Boards/libraries, look at the README.md and library.properties, and if the README marks the plugin "stable", include it in the collection. If all our READMEs would follow a similar structure (they mostly do, with few exceptions), that would allow lifting out the introductions programmatically.

The upside of this is that it would be always up to date (and we can add travis badges, last commit info, version number, etc). The downside is that we need to mark plugins stable / experimental / obsolete / whatever. Another benefit of doing it automatically is that we could have a "Supported plugins", an "Experimental Plugins" and perhaps an "Obsolete / Broken plugins" section too, all generated from the same source by the same tool.

We could also add "Community plugins" by going through the repos on GitHub tagged with kaleidoscope-plugin, and collect info from those too.

@algernon
Copy link
Contributor

It could be a bit like travis-status in Kaleidoscope-Plugin.

@algernon
Copy link
Contributor

If we end up with an automatic method, and we write it in JS (as a library) or ClojureScript, that would allow me to reuse the same thing in Chrysalis too. ;)

@obra
Copy link
Member Author

obra commented Jun 8, 2020

https://kaleidoscope.readthedocs.io/en/latest/#plugins solves this, I believe.

@obra obra closed this as completed Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants