Sublime Forum

How to display a readme file?

#1

if my plugin is installed as .sublime-package in “installed packages” folder.Im having the following .sublime-menu file…what should be the args for a readme that is inside the .sublime-package
[
{
“caption”: “Preferences”,
“mnemonic”: “n”,
“id”: “preferences”,
“children”:
[
{
“caption”: “Package Settings”,
“mnemonic”: “P”,
“id”: “package-settings”,
“children”:
[
{
“caption”: “SublimePluginFileUpload”,
“children”:
[
{
“command”: “open_file”,
“args”: {“file”: “${packages}/SublimePluginFileUpload/README.md”},
“caption”: “README”
},
// { “caption”: “-” },
{
“command”: “open_file”,
“args”: {“file”: “${packages}/User/SublimePluginFileUpload.sublime-settings”},
“caption”: “Settings – User”
},
]
}
]
}
]
}
]

0 Likes

#2

First, please format your message properly: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Then, here’s what it should be:

You got it? Nothing! Yep, you should tell your user to use ReadmePlease.

0 Likes

#3

What you have there should work for you regardless of how your package is deployed (i.e. as an Unpacked package or as a sublime-package file). That applies to both the settings and the README entries.

1 Like