From 399326e19b30b0a080db10f5e19583bb23ae012b Mon Sep 17 00:00:00 2001
From: thomasabishop <tactonbishop@gmail.com>
Date: Tue, 21 Jan 2025 17:59:04 +0000
Subject: [PATCH] chore: update readme

---
 README.md | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 1c7613d..fd98346 100644
--- a/README.md
+++ b/README.md
@@ -5,23 +5,16 @@ formats it so that it can be compiled as a [Neuron](https://neuron.zettel.page/)
 
 ## Local development
 
+Activate the virtual environment:
+
 ```sh
 source venv/bin/activate
-neuron-zk-generator
 ```
 
-## Run as local application
+Run:
 
-```
-pipx install [local_path_to_application]
-neuron-zk-generator
-```
-
-### Update after changes
-
-```
-pipx uninstall neuron-zk-generator
-pipx install [local_path_to_application]
+```sh
+python3 src/app.py
 ```
 
 ## Build single executable
@@ -29,10 +22,12 @@ pipx install [local_path_to_application]
 Use `pyinstaller` to create single executable file. `pyinstaller` is installed
 along with other packages specified in `setup.py`.
 
+Ensure the virtual environment is running.
+
 From root:
 
 ```sh
-pyinstaller -F src/app.py
+pyinstaller --onefile src/app.py --name neuron-zk-generator
 # -F compiles to single file
 ```
 
@@ -41,5 +36,17 @@ Outputs to `neuron-zk-generator/dist/app`.
 Sourcing the executable:
 
 ```sh
-/home/thomas/repos/neuron-zk-generator/dist/app
+${HOME}/repos/neuron-zk-generator/dist/app
+```
+
+### Run executable as program
+
+```sh
+sudo mv ${HOME}/repos/neuron-zk-generator/dist/app /usr/local/bin
+```
+
+Then run with:
+
+```
+neuron-zk-generator
 ```