From b290e838de5d012084605cbce9085f9efd9365ad Mon Sep 17 00:00:00 2001 From: Hyperling Date: Tue, 7 Mar 2023 05:52:56 -0600 Subject: [PATCH] Update readme. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f74c18..ad359ab 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,19 @@ Simple UI for entering food choices and whether they caused any issues such as headaches, migraines, upset digestion, etc. ## How To Run -TBD +This project assumes an apt-based OS and was written on Ubuntu. + +Clone the project + +`git clone https://github.com/Hyperling/food_diary food_diary_app` + +Move into the directory + +`cd food_diary_app` + +Run the project. + +`./run.sh` + +## testing +`test.sh` has been provided for showing how to interact with the APIs.