From 62a05f91bad621fe47a3979c21365772dba37942 Mon Sep 17 00:00:00 2001 From: William Valentin Date: Sat, 26 Jul 2025 13:04:55 -0700 Subject: [PATCH] Add deployment instructions and make options to README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 8def2bc..bbc9df8 100644 --- a/README.md +++ b/README.md @@ -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 +```