thomasabishop/neuron-zk-generator
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
thomasabishop 2025-01-21 17:59:04 +00:00
parent e8b518d6a5
commit 399326e19b
1 changed files with 21 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -5,23 +5,16 @@ formats it so that it can be compiled as a [Neuron](https://neuron.zettel.page/)
## Local development ## Local development
Activate the virtual environment:
```sh ```sh
source venv/bin/activate source venv/bin/activate
neuron-zk-generator
``` ```
## Run as local application Run:
``` ```sh
pipx install [local_path_to_application] python3 src/app.py
neuron-zk-generator
```
### Update after changes
```
pipx uninstall neuron-zk-generator
pipx install [local_path_to_application]
``` ```
## Build single executable ## Build single executable
@ -29,10 +22,12 @@ pipx install [local_path_to_application]
Use `pyinstaller` to create single executable file. `pyinstaller` is installed Use `pyinstaller` to create single executable file. `pyinstaller` is installed
along with other packages specified in `setup.py`. along with other packages specified in `setup.py`.
Ensure the virtual environment is running.
From root: From root:
```sh ```sh
pyinstaller -F src/app.py pyinstaller --onefile src/app.py --name neuron-zk-generator
# -F compiles to single file # -F compiles to single file
``` ```
@ -41,5 +36,17 @@ Outputs to `neuron-zk-generator/dist/app`.
Sourcing the executable: Sourcing the executable:
```sh ```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
``` ```