Skip to content

Commit c44fdf3

Browse files
committed
Add documentation.
1 parent 7370402 commit c44fdf3

File tree

2 files changed

+16
-23
lines changed

2 files changed

+16
-23
lines changed

README.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,32 @@
11
# LabView QuickDrop AddLabels
22

3-
A LabVIEW Quick-Drop (QD) plug-in for adding or removing labels to block diagram elements and subdiagram labels for structure elements.
3+
A LabVIEW Quick-Drop (QD) plug-in to easily add or remove labels to blockdiagram elements.
44

55

66
## Installation
7-
Place the content of the zip file in your `<LabVIEW>\resource\dialog\QuickDrop\plugins` folder.
7+
Place the `Add Labels.vi` file in your `<LabVIEW>\resource\dialog\QuickDrop\plugins` folder.
88

99
## Usage
1010

1111
This quick-drop plug-in works only in the block diagram.
12-
Press Ctrl+Space Ctrl+Q to add the labels to the selected items.
13-
If the plug-in is called using the SHIFT key than the label will be removed.
1412

15-
## Hints
16-
The plug-in has been developed with LabVIEW 2016.
13+
### Add or remove a label to SubVIs
14+
15+
Select a SubVI within a blockdiagram.
16+
Press `Ctrl+Space` and `Ctrl+Q` to add a label to a SubVI.
17+
For removing the label press `Ctrl+Space`and `Ctrl+Shift+Q`
1718

18-
## License
1919

20-
MIT License
20+
The animated GIF below show the three possible options of the plugin:
2121

22-
Permission is hereby granted, free of charge, to any person obtaining a copy
23-
of this software and associated documentation files (the "Software"), to deal
24-
in the Software without restriction, including without limitation the rights
25-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
26-
copies of the Software, and to permit persons to whom the Software is
27-
furnished to do so, subject to the following conditions:
22+
* Add/Remove a label to a SubVI.
23+
* Add/Remove a subdiagram label to a structure element.
24+
* Add/Remove a label to a wire
25+
* Show again an already set wire label
2826

29-
The above copyright notice and this permission notice shall be included in all
30-
copies or substantial portions of the Software.
27+
![Using the plug-in](../master/usage.gif)
3128

32-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38-
SOFTWARE.
29+
It is also possible to select more than one element within a blockdiagram. Therefore the appropriate label will be added to the selected elements.
3930

31+
## Hints
32+
The plug-in is developed in LabVIEW 2016. If you have an older version of LabView you have to save the provided project to this older version by yourself.

usage.gif

1.49 MB
Loading

0 commit comments

Comments
 (0)