chore: update readme
This commit is contained in:
parent
e8b518d6a5
commit
399326e19b
1 changed files with 21 additions and 14 deletions
35
README.md
35
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
|
||||
```
|
||||
|
|
Loading…
Add table
Reference in a new issue