search

willowtreeapps / Hyperion-Android

App Debugging & Inspection Tool for Android
MIT License
1.95k stars 144 forks source link

How about a little readme in each plugin's directory? #95

Open Aditya94A opened 6 years ago

Aditya94A commented 6 years ago

To easily convey what the plugin does, what it looks like etc. Or maybe some wiki pages? Or both?

nishtahir commented 6 years ago

How does everyone feel about this going in the main README.md? I'm concerned that having separate READMEs for the plugins might make it hard to quickly look up what they do.

ToxicBakery commented 6 years ago

I'm not a fan of mile-long readme files personally. Additionally, some plugins may require quite a bit of explanation while others may require little more than a paragraph making formatting of a large number of plugins on the same page a little unbalanced.

nishtahir commented 6 years ago

How about something like a table of contents on the main README that links to more elaborate READMEs in their respective folders?

kvithayathil commented 6 years ago

That would make more sense. Have the main README outline the project, build steps etc. A links to individual plugin wikis can be listed

ToxicBakery commented 6 years ago

How about something like a table of contents on the main README that links to more elaborate READMEs in their respective folders?

That's what I thought this was suggesting :laughing:

Aditya94A commented 6 years ago

Any updates on this?

The README is currently just asking us to add a bunch of dependencies without any indication whatsoever as to what they actually do.

Does geiger counter make my app magically detect alpha particles?

How about putting a small description anywhere temporarily (like just a list below #Usage) and then move them to wherever (individual READMEs in each folder or wiki or whatever) when we settle on it.

mrk-han commented 6 years ago

https://github.com/willowtreeapps/Hyperion-Android#third-party-plugins-1

A Third Party Plugins section was added. However, Geiger Counter has not been added to the list yet!

Maybe we could move the list of Third Party Plugins higher up in the README for visibility? Perhaps in the same section as https://github.com/willowtreeapps/Hyperion-Android#third-party-plugins

As of now, we have two Third Party Plugins sections. PR incoming

mrk-han commented 6 years ago

Ahh, I see... it seems we may want to actually add a section which describes every plugin available, and not just the descriptions of the Third Party Plugins.