Skip to content

Commit 363decc

Browse files
Added Readme
1 parent c8ea9bc commit 363decc

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

ui-vue-starter/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Vue Starter Plugin
2+
3+
This plugin is a good place to get started when building a Adobe Photoshop plugin using Vue JS. It comes defined with all the dependencies that you'll need to get started. As this is a Vue project, you'll need to do some initial configuration before this will be usable in Adobe Photoshop.
4+
5+
## Install dependencies
6+
7+
First ensure that your terminal is in the root of this project. Then:
8+
9+
For `yarn` users, install all dependencies using:
10+
11+
```
12+
yarn install
13+
```
14+
15+
For `npm` users, install all dependencies using:
16+
17+
```
18+
npm install
19+
```
20+
21+
## Build Process
22+
23+
There are two ways to build the plugin for use in Adobe Photoshop:
24+
25+
- `yarn watch` or `npm run watch` will build a development version of the plugin, and recompile everytime you make a change to the source files. The result is placed in `dist`.
26+
- `yarn build` or `npm run build` will build a production version of the plugin and place it in `dist`. It will not update every time you make a change to the source files.
27+
28+
> You **must** run either `watch` or `build` prior to trying to use within Photoshop!
29+
30+
## Launching in Photoshop
31+
32+
You can use the UXP Developer Tools to load the plugin into Photoshop.
33+
34+
If the plugin hasn't already been added to your workspace in the UXP Developer Tools, you can add it by clicking "Add Plugin..." and selecting `dist/manifest.json`. **DO NOT** select the `manifest.json` file inside the `plugin` folder.
35+
36+
Once added, you can load it into Photoshop by clicking the ••• button on the corresponding row, and clicking "Load". Switch to Photoshop and you should see the starter panel.
37+
38+
## What this plugin does
39+
40+
This plugin doesn't do much, but does illustrate how to create a panel in Photoshop with `entrypoints`, where you can see the count of clicks on the button alongwith a hello world message.

0 commit comments

Comments
 (0)