From f0a029ba4482b73a23e50c5ece7c17affd6f49d6 Mon Sep 17 00:00:00 2001
From: Peter Story <peter.garth.story@gmail.com>
Date: Tue, 26 Sep 2023 14:08:33 -0400
Subject: [PATCH] Add pydiode-gui command

For #3
---
 README.md                    | 12 +++++++++++-
 pyproject.toml               |  1 +
 gui.py => src/pydiode/gui.py |  0
 3 files changed, 12 insertions(+), 1 deletion(-)
 rename gui.py => src/pydiode/gui.py (100%)

diff --git a/README.md b/README.md
index 6d453b0..49ae2a0 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,17 @@ To install from source, clone the repo then run:
 pip install .
 ```
 
-## Usage
+To run the GUI, Tk must be installed. For example, on macOS:
+```
+sudo port install py311-tkinter
+sudo port install tk -x11 +quartz
+```
+
+## GUI Usage
+
+The `pydiode-gui` command will launch the user interface.
+
+## Command-Line Usage
 
 Documentation:
 ```
diff --git a/pyproject.toml b/pyproject.toml
index 044fac8..4031ef5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -23,3 +23,4 @@ classifiers = [
 
 [project.scripts]
 pydiode = "pydiode.main:main"
+pydiode-gui = "pydiode.gui:main"
diff --git a/gui.py b/src/pydiode/gui.py
similarity index 100%
rename from gui.py
rename to src/pydiode/gui.py