README: update w/gui instructions

README.md

@@ -1,12 +1,10 @@
-# Testing Firmware for the Sinara 1550 Kirdy
-
-- This repo is for testing only. Not intended for production use.
+# Firmware for the Sinara 1550 Laser Diode Driver Kirdy
 
 ## Building
 
 ### Reproducible build with Nix
 
-kirdy firmware is packaged using the [Nix](https://nixos.org) Flakes system. Install Nix 2.4+ and enable flakes by adding ``experimental-features = nix-command flakes`` to ``nix.conf`` (e.g. ``~/.config/nix/nix.conf``). 
+Kirdy firmware is packaged using the [Nix](https://nixos.org) Flakes system. Install Nix 2.4+ and enable flakes by adding ``experimental-features = nix-command flakes`` to ``nix.conf`` (e.g. ``~/.config/nix/nix.conf``).
 
 Once you have Flakes enabled, you can use ``nix build`` to build the firmware.
 
@@ -77,3 +75,20 @@ With JTAG/SWD adapter connected, issue the following command:
 ```shell
 openocd -f interface/stlink.cfg -f target/stm32f4x.cfg -c "flash init; init; halt; flash erase_sector 0 11 last; reset; exit"
 ```
+
+## Driver and GUI usage
+
+A Python driver library and GUI control panel for Kirdy are included in the directory `pykirdy`. For usage of the Python driver see inline documentation. To launch the GUI, run
+
+```shell
+nix run git+https://git.m-labs.hk/M-Labs/kirdy#kirdy_gui
+```
+
+Or, without Nix, install the `pykirdy` library and run `kirdy_qt`:
+
+```shell
+pip install git+https://git.m-labs.hk/M-Labs/kirdy#subdirectory=pykirdy
+kirdy_qt
+```
+
+The current firmware default IP address and port are 192.168.1.28 and 1550.