Skip to content

Commit 6890aa5

Browse files
authored
Update README.md
1 parent cf9f3a4 commit 6890aa5

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,49 @@
11
# ![FDMLControl_logo](images/FDMLControl_icon.png) FDMLControl
22

3-
FDMLControl enables the control of he Optores FDML laser via a serial connection.
3+
FDMLControl enables the control of the [Optores](https://www.optores.com/) FDML laser via a serial connection.
4+
5+
<!-- this is a
6+
comment - with hyphen -->
7+
8+
![screenshot](images/FDMLConrol_screenshotWin10.PNG)
9+
10+
Features
11+
--------
12+
13+
* **Dynamic GUI generation.** All the FDML laser parameters that can be seen in the graphical user interface are generated from a XML file during start up. The XML file (fdml_commands.xml) is placed in the same folder as the executable and can be modified to adjust FDMLControl to possible firmware updates of the Optores FDML laser.
14+
15+
* **Expert mode** enables access to more advanced features such as a custom command console.
16+
17+
* **Admin privileges** can be obtained by placing a file with the corresponding key in the same folder as the executable. This makes it possible to change laser parameters which otherwise could not be accessed. FDMLControl obtaines admin privileges automatically if "key.dat" is found in the same folder as the executable during start up. Please contact [Optores](https://www.optores.com/) if you need the admin key for your laser.
18+
19+
* **Cross platform** FDMLControl runs on Windows and Linux (Probably also on Mac, but this has not been tested yet.)
20+
21+
22+
Installing
23+
----------
24+
25+
A precompiled package for Windows (64bit) can be downloaded from:
26+
[Win64Link](https://.....).
27+
28+
Extract the zip archive and execute FDMLControl, installation is not necessary.
29+
30+
If you need FDMLControl for a different operating system, the easiest way is to compile it yourself. See the compiling section.
31+
32+
Compiling
33+
---------
34+
35+
Compiling FDMLControl requires installation of [Qt](https://www.qt.io/) Once you have installed Qt the easiest way tom compile
36+
FDMLControl is with the QtCreator. Clone/Download the FDMLControl source files and open the .pro file with QtCreator to compile FDMLControl for your operating system.
37+
38+
Contributors
39+
--------------------
40+
41+
Alexander Heisterkamp - Institute of Quantum Optics, Leibniz University Hannover, Welfengarten 1, 30167 Hannover,
42+
Germany
43+
Tammo Ripken- Industrial and Biomedical Optics Department, Laser Zentrum Hannover e.V., Hollerithallee 8,
44+
30419 Hannover, Germany
45+
46+
47+
48+
## License
49+
FDMLControl is free software and licensed under GPLv3. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)