Sublime Forum

**aidlml** · February 12, 2020, 9:29am

How to launch README file when the plugin is installed for first time to instruct the user?

**jfcherng** · February 12, 2020, 9:35am

Create a messages.json in the plugin’s root folder and add a "install" key in it.

sublimelsp/LSP/blob/c48aeb70bf3e5438365bcfb8a53490dd57203dcd/messages.json#L2


{
    "install": "messages/install.txt",
    "0.2.0": "messages/0.2.0.txt",
    "0.2.1": "messages/0.2.1.txt",
    "0.2.2": "messages/0.2.2.txt",
    "0.3.0": "messages/0.3.0.txt",
    "0.4.0": "messages/0.4.0.txt",
    "0.4.1": "messages/0.4.1.txt",
    "0.4.2": "messages/0.4.2.txt",
    "0.5.0": "messages/0.5.0.txt",
    "0.6.0": "messages/0.6.0.txt",
    "0.7.0": "messages/0.7.0.txt",

**aidlml** · February 12, 2020, 9:50am

How to make sure it that Readme file should be shown only when user installs the plugin ?

**jfcherng** · February 12, 2020, 9:51am

That’s what it’s for…

**aidlml** · February 12, 2020, 9:53am

You mean to say that "install" is the key which will handle this use case ?

**jfcherng** · February 12, 2020, 9:53am

Yes. That’s what it’s for…

**jfcherng** · February 12, 2020, 9:55am

if you have further question, read the really short doc first then.
https://packagecontrol.io/docs/messaging

**aidlml** · February 12, 2020, 9:57am

I think I missed this documentation. Thanks for sharing @jfcherng.

Launch README file when the plugin is installed for first time