a note regarding "use this template" button

This button is not visible if you are not logged in to GitHub.
It may be a bit confusing for first-timers so I suggest the note to be added
This commit is contained in:
Maciej Beimcik 2021-03-09 10:47:18 +01:00 committed by Lishid
parent 5355e3337e
commit 123b00ca52

View File

@ -19,7 +19,7 @@ This sample plugin demonstrates some of the basic functionality the plugin API c
Quick starting guide for new plugin devs: Quick starting guide for new plugin devs:
- Make a copy of this repo as a template with the "Use this template" button. - Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. - Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder. - Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. - Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.