package_control icon indicating copy to clipboard operation
package_control copied to clipboard

man or help command

Open martinAnsty opened this issue 12 years ago • 4 comments

Currently when you install a package the only way of figuring out the associated commands is to check the package preferences (if it has any) or visit the github page. I'm proposing a "Package control: man" command that lists installed packages, selecting one brings up the readme file within ST

martinAnsty avatar Feb 24 '12 19:02 martinAnsty

I would also like to have an option to have the readme open (in ST) immediately after install

malmckay avatar Nov 29 '12 15:11 malmckay

I'd really like this. Not knowing anything about a plugin when installed is really annoying.

And it seems to have gotten worse. I recently installed ST3 and started re-installing some of my packages.

Back some time ago when I installed packages for ST2 I could at least use "Preferences: Browse Packages" and manually open up the README in the right /Packages/* folder.

Now a number of packages are instead installed to ./Installed Packages as .sublime-package files so their README isn't even easily accessible.

I now have to open up a web browser and manually search packagecontrol.io to get any information on packages I already have installed.

dantman avatar Feb 13 '15 06:02 dantman

You can use PackageResourceViewer to easily inspect the Installed Packages and open files within.

Other than that, it's currently the package author's decision to show or not to show a message on install. However adding an option to automatically open the readme if there was no install message sounds like a fine suggestion to me.

FichteFoll avatar Feb 13 '15 12:02 FichteFoll

The requested functionality is provided by https://packagecontrol.io/packages/ReadmePlease

deathaxe avatar Sep 12 '22 13:09 deathaxe