From 846c36dc85134c01b59256157d64e96f7957b199 Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Sun, 15 Oct 2023 11:36:30 +1000 Subject: [PATCH] Updates more readme. --- build/README.md | 22 +++++++++++++++++++++- build/figurines/README.md | 2 +- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/build/README.md b/build/README.md index 2891c9e..b8b086e 100644 --- a/build/README.md +++ b/build/README.md @@ -1,6 +1,26 @@ # BUILD Build code goes here when project underway -## Build Instructions in order of process + +## Initial Environment Setup +Our project relies on several different libraries in order for it to function. As most of our project is written in Python, there is an [`environment.yaml`](https://github.com/lucashicks1/lambda-deco3801/blob/main/environment.yaml) file that has been created, allowing you to create your own conda virtual environment. You can create and activate this environment with the following: + +``` +conda env create -f environment.yaml +conda activate lambda-env +``` +Or you can create your own environment and install the packages with + +``` +conda create -n your_env_name +conda activate your_env_name +conda install numpy pillow pytesseract matplotlib pymongo requests +conda install -c conda-forge fastapi pydantic uvicorn-standard +pip install opencv-python-headless +``` + +Once this environment is setup, all the needed dependencies for our python components should be installed. + +## Build Instructions for each project component 1. [Database](../build/db-handler/README.md) 2. [Camera](../build/vision/README.md) 3. [Display](../build/ui-display/frontend-app/README.md) diff --git a/build/figurines/README.md b/build/figurines/README.md index 6c297b7..a8ae10f 100644 --- a/build/figurines/README.md +++ b/build/figurines/README.md @@ -1,5 +1,5 @@ # Microcontroller Communications 1. Connect the Seeduino Xiao to a serial port using provided USB-C to USB-A cable -2. Double click the .bat file located in this directory +2. Double click the [`microcontroller_communications.bat`](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/figurines/microcontroller_communications.bat) file located in this directory 3. The file will download all required python libraries, so please wait for it to finish 4. The program will run on completion of installations \ No newline at end of file