Skip to content

Commit 463d6db

Browse files
committed
Added docs to README
1 parent 812fbed commit 463d6db

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ If you don't have PyCharm you can get it from here: https://www.jetbrains.com/py
2323
1. The plugin adds the update and deploy action to two places:
2424
1. The module menu, opened up by right clicking the module in the project tool window on the left:
2525
![Project Tool Window](/docs/images/module_menu.png)
26-
2. The run and run toolbar on the top right:
26+
2. The run and build toolbar on the top right:
2727
![Runner Actions](/docs/images/build_menu.png)
28-
29-
2. Before running the plugin, you'll need to have a file named `deployment.xml` in the project root folder,
28+
2. Click the Publish button whenever you want to update and deploy the current project.
29+
3. Before running the plugin, you'll need to have a file named `deployment.xml` in the project root folder,
3030
this file tells the plugin how and which driver you're trying to update, you can use this snippet as a template:
3131
``` xml
3232
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
@@ -47,3 +47,6 @@ If you don't have PyCharm you can get it from here: https://www.jetbrains.com/py
4747
<entry key="fileFilters">fileFilters</entry>
4848
</properties>
4949
```
50+
4. Upon activation the plugin collects and zipps the contents of the project (excluding filtered files, see `deployment.xml` `fileFilters` property),
51+
the new zip is placed in a folder named `deployment/` in the project root.
52+
Then, the plugin uses the settings in the `deployment.xml` file to contact the server and updae the driver files currently online.

0 commit comments

Comments
 (0)