Merge branch 'main' of github.com:lucashicks1/lambda-deco3801

build/README.md

@@ -1,8 +1,28 @@
-# BUILD
-Build code goes here when project underway
-## Build Instructions in order of process
-1. [Database](../build/db-handler/README.md)
-2. [Camera](../build/vision/README.md)
+# Build guide
+Please follow these instructions to run the project.
+
+## 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 Handler](../build/db-handler/README.md)
+2. [Image Recognition](../build/vision/README.md)
 3. [Display](../build/ui-display/frontend-app/README.md)
 4. [Microcontroller](../build/microcontroller/README.md)
 5. [Microcontroller Communication](../build/figurines/README.md)

build/db-handler/README.md

@@ -1,4 +1,4 @@
-# Database handler
+# Database Handler
 
 ## Overview
 
@@ -8,22 +8,12 @@ This database handler is a web-based RESTful API microservice which is solely re
 
 ### Installation
 
-You need a couple of dependencies if you want to run the uvicorn server locally to serve the API. Run these options:
+**NOTE: These steps can be skipped if the initial install instructions have been followed on the overall build [`README`](https://github.com/lucashicks1/lambda-deco3801/tree/main/build)**
 
-1. Install using conda environment
-
-For convinience, a conda environment has been created so that all project dependencies can be installed using as few commands as possible. See more on this option [here](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/vision/README.md#dependencies)
-
-2. Install with `requirements.txt`:
+If you have not setup the conda environment, run the following command:
 
 `pip install -r requirements.txt`
 
-3. Install all dependencies individually:
-
-`pip install fastapi pymongo pydantic "uvicorn[standard]"`
-
-*Note: A python environment with every project dependency is available for use, so this step could be skipped if the other environment is set up.*
-
 ### Database Setup
 This API microservice uses either a local monogbd database or a remote database hosted in the cloud. If the microservice is unable to connect to the remote instance running in the cloud, it will connect to the local database as a backup.
 

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