Skip to content

Commit 0039c3e

Browse files
Add quickstart guide
1 parent a47760d commit 0039c3e

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

Documentation/Quickstart.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Quickstart Guide
2+
3+
## Compile the DLL
4+
The `StrongridDLL.dll` can be compiled from the source files hosted on a separate repository.
5+
The compiled file should be placed in the `/builds/StrongridDLL`folder.
6+
A copy of the compiled file is hosted on this repository for convenience.
7+
8+
## Compile the LabVIEW files
9+
The source files for the LabVIEW interface can be found in the `/LabVIEW PRL Library` folder.
10+
The project contains all the necessary components of the LabVIEW interface and pre-configured build specifications.
11+
12+
To compile the files, the user should build the pre-configured build specifications.
13+
This will prepare the files for the next step and place them in the `/builds/S3DK Labview` folder.
14+
15+
## VI package
16+
For convenience, the files can be packaged as a VI package to be installed through the VI package manager.
17+
A build script is provided to prepare the package.
18+
The script should be opened with the VI package manager, where the script can be edited or simply used to generate the `*.vipm` file.
19+
20+
### Warning
21+
The VI package manager is sensitive to the file structure of the compiled LabVIEW files.
22+
Any change in its structure will remove the icon information included in the build script.

0 commit comments

Comments
 (0)