Add deployment instructions and make options to README

This commit is contained in:
William Valentin
2025-07-26 13:04:55 -07:00
parent 15be1733ea
commit 62a05f91ba

View File

@@ -39,3 +39,34 @@ make build
```shell
make test
```
## Deploy the app
### Linux / Unix
The app will be deployed in **~/Applications**, the CSV data file *thechart_data.csv* will be store in **~/Documents**.
```shell
make deploy
```
### MacOS / Windows
TODO: use OS specific flags with *pyinstaller*.
## Make options
Show the help menu:
```shell
make help
```
Sub-commands listed below:
```
attach Open a shell in the container
build Build the Docker image
deploy Deploy standalone app executable
format Format the code
help Show this help
install Set up the development environment
lint Run the linter
requirements Export the requirements to a file
run Run the application
shell Open a shell in the local environment
start Start the app
stop Stop the app
test Run the tests
```