Add pydiode-gui command

For #3
ClarkuCSCI · Sep 26, 2023 · f0a029b · f0a029b
1 parent a4f01c4
commit f0a029b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git 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
@@ -23,3 +23,4 @@ classifiers = [
 
 [project.scripts]
 pydiode = "pydiode.main:main"
+pydiode-gui = "pydiode.gui:main"
diff --git a/gui.py → src/pydiode/gui.py b/gui.py → src/pydiode/gui.py
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,3 +23,4 @@ classifiers = [

		[project.scripts]
		pydiode = "pydiode.main:main"
		pydiode-gui = "pydiode.gui:main"